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()

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) Returns a User by its name, if it exists.
Class<ScpCfUser>	getUserClass() Returns the platform-specific implementation class of User.
protected User	newMockedUser() Instantiates a mocked User.
Optional<User>	resolveCurrentUser() Resolves the current User using the platform-specific lookup.

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

getCurrentUser, getCurrentUserIfAuthenticated, getMockedUser

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()

Method Detail

getUserClass

@Nonnull
public Class<ScpCfUser> getUserClass()

Returns the platform-specific implementation class of User. For internal use only.

Returns:

The type of the platform-specific implementation.

newMockedUser

@Nonnull
protected User newMockedUser()

Instantiates a mocked User.

Specified by:

newMockedUser in class AbstractUserFacade

Returns:

A new mocked User.

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

Resolves the current User using the platform-specific lookup. For internal use only.

Caution: This method must only be invoked within the container-managed thread of a request.

Returns:

An Optional of the current User.

Throws:

UserAccessException - If there is an issue while resolving the User.

See Also:

UserRequestContextListener

getUserByName

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

Returns a User by its name, if it exists.

Parameters:

name - The name of the User to find.

Returns:

An optional, wrapping the user with the given name.