com.sap.cloud.sdk.cloudplatform.security.user

Class ScpCfUserFacade

java.lang.Object

com.sap.cloud.sdk.cloudplatform.security.user.AbstractUserFacade

com.sap.cloud.sdk.cloudplatform.security.user.ScpCfUserFacade

All Implemented Interfaces:

UserFacade

public class ScpCfUserFacade
extends AbstractUserFacade

Facade providing access to user information on SAP Cloud Platform Cloud Foundry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VARIABLE_ALLOW_MOCKED_AUTH_HEADER

Constructor Summary

Constructors

Constructor and Description
ScpCfUserFacade() Default constructor with default strategies.
ScpCfUserFacade(LocalScopePrefixProvider localScopePrefixProvider) Use this constructor if you want to override the default strategy for determining the local scope prefix.

Method Summary

Modifier and Type	Method and Description
protected Optional<User>	getMockedUserAsFallback() Returns a mocked User as fallback, if the environment variable "ALLOW_MOCKED_AUTH_HEADER" is set to "true".
Optional<User>	getUserByName(String name)
Class<ScpCfUser>	getUserClass()
protected User	newMockedUser()
Optional<User>	resolveCurrentUser()

Methods inherited from class com.sap.cloud.sdk.cloudplatform.security.user.AbstractUserFacade

getCurrentUser, getCurrentUserIfAuthenticated, getMockedUser, tryGetCurrentUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VARIABLE_ALLOW_MOCKED_AUTH_HEADER

public static final String VARIABLE_ALLOW_MOCKED_AUTH_HEADER

See Also:

Constant Field Values

Constructor Detail

ScpCfUserFacade

public ScpCfUserFacade(@Nullable
                       LocalScopePrefixProvider localScopePrefixProvider)

Use this constructor if you want to override the default strategy for determining the local scope prefix. By default (i.e. when passing null), the DefaultLocalScopePrefixProvider is used.

Parameters:

localScopePrefixProvider - An implementation of the LocalScopePrefixProvider interface. Defaults to DefaultLocalScopePrefixProvider.

ScpCfUserFacade

public ScpCfUserFacade()

Default constructor with default strategies.

Method Detail

getUserClass

@Nonnull
public Class<ScpCfUser> getUserClass()

newMockedUser

@Nonnull
protected User newMockedUser()

Specified by:

newMockedUser in class AbstractUserFacade

getMockedUserAsFallback

@Nonnull
protected Optional<User> getMockedUserAsFallback()

Returns a mocked User as fallback, if the environment variable "ALLOW_MOCKED_AUTH_HEADER" is set to "true".

Returns:

The mocked User.

resolveCurrentUser

@Nonnull
public Optional<User> resolveCurrentUser()
                                           throws UserAccessException

Throws:

UserAccessException

getUserByName

@Nonnull
public Optional<User> getUserByName(String name)