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

Interface Principal

All Known Implementing Classes:

DefaultPrincipal, ScpCfPrincipal, ScpNeoPrincipal

public interface Principal

This represents the information available an authenticated entity.

In case of basic authentication this will directly represent a user, in case of client credentials this is the client.

Method Summary

Modifier and Type	Method and Description
io.vavr.control.Try<PrincipalAttribute>	getAttribute(String attributeName) Returns the attribute specified by the given name, wrapped in a Try.
Set<Authorization>	getAuthorizations() The authorizations this Principal has.
String	getPrincipalId() The identifier for this Principal.

Method Detail

getPrincipalId

@Nonnull
String getPrincipalId()

The identifier for this Principal.

Returns:

The identifier.

getAuthorizations

@Nonnull
Set<Authorization> getAuthorizations()

The authorizations this Principal has.

Returns:

A Set with the authentications.

getAttribute

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

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

Parameters:

attributeName - The name of the attribute to get.

Returns:

The attribute of a user by the attribute name.