com.sap.cloud.sdk.cloudplatform.security.principal

Class DefaultPrincipal

java.lang.Object

com.sap.cloud.sdk.cloudplatform.security.principal.DefaultPrincipal

All Implemented Interfaces:

Principal

Direct Known Subclasses:

ScpCfPrincipal, ScpNeoPrincipal

public class DefaultPrincipal
extends Object
implements Principal

This implementation of Principal represents the information available for an authenticated entity.

Constructor Summary

Constructors

Constructor and Description
DefaultPrincipal(String principalId, Set<Authorization> localAuthorizations, Map<String,PrincipalAttribute> attributes)
DefaultPrincipal(String principalId, Set<Authorization> localAuthorizations, Set<Authorization> allAuthorizations, Set<Audience> audiences, Map<String,PrincipalAttribute> attributes) Creates a new DefaultPrincipal.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
io.vavr.control.Try<PrincipalAttribute>	getAttribute(String attributeName) Returns the attribute specified by the given name, wrapped in a Try.
Map<String,PrincipalAttribute>	getAttributes()
Set<Authorization>	getAuthorizations() The authorizations this Principal has.
Map<Audience,Set<Authorization>>	getAuthorizationsByAudience() The authorizations this Principal has grouped by audience.
Set<Authorization>	getLocalAuthorizations()
String	getPrincipalId() The identifier for this Principal.
int	hashCode()
void	setAuthorizationsByAudience(Map<Audience,Set<Authorization>> authorizationsByAudience)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultPrincipal

@Beta
public DefaultPrincipal(@Nonnull
                              String principalId,
                              @Nonnull
                              Set<Authorization> localAuthorizations,
                              @Nonnull
                              Set<Authorization> allAuthorizations,
                              @Nonnull
                              Set<Audience> audiences,
                              @Nonnull
                              Map<String,PrincipalAttribute> attributes)

Creates a new DefaultPrincipal.

Parameters:

principalId - The ID of the principal

localAuthorizations - The local authorizations of the principal

allAuthorizations - All authorizations of the principal

audiences - The audiences of the principal

attributes - The attributes of the principal

DefaultPrincipal

public DefaultPrincipal(@Nonnull
                        String principalId,
                        @Nonnull
                        Set<Authorization> localAuthorizations,
                        @Nonnull
                        Map<String,PrincipalAttribute> attributes)

Method Detail

getAuthorizations

@Nonnull
public Set<Authorization> getAuthorizations()

The authorizations this Principal has.

Specified by:

getAuthorizations in interface Principal

Returns:

A Set with the authentications.

getAuthorizationsByAudience

@Nonnull
public Map<Audience,Set<Authorization>> getAuthorizationsByAudience()

Description copied from interface: Principal

The authorizations this Principal has grouped by audience.

Specified by:

getAuthorizationsByAudience in interface Principal

Returns:

A Map with the authentications grouped by audience.

getAttribute

@Nonnull
public io.vavr.control.Try<PrincipalAttribute> getAttribute(@Nonnull
                                                                     String attributeName)

Returns the attribute specified by the given name, wrapped in a Try.

Specified by:

getAttribute in interface Principal

Parameters:

attributeName - The name of the attribute to get.

Returns:

The attribute of a user by the attribute name.

getLocalAuthorizations

@Nonnull
public Set<Authorization> getLocalAuthorizations()

getAttributes

@Nonnull
public Map<String,PrincipalAttribute> getAttributes()

setAuthorizationsByAudience

public void setAuthorizationsByAudience(@Nonnull
                                        Map<Audience,Set<Authorization>> authorizationsByAudience)

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(@Nullable
                           Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getPrincipalId

@Nonnull
public String getPrincipalId()

The identifier for this Principal.

Specified by:

getPrincipalId in interface Principal

Returns:

The identifier.