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

Class AbstractUserFacade

java.lang.Object

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

All Implemented Interfaces:

UserFacade

Direct Known Subclasses:

ScpCfUserFacade, ScpNeoUserFacade

public abstract class AbstractUserFacade
extends Object
implements UserFacade

Abstract base class for UserFacades which allows to use a mocked User if the environment variable "USE_MOCKED_USER" is set to "true".

Constructor Summary

Constructors

Constructor and Description
AbstractUserFacade()

Method Summary

Modifier and Type	Method and Description
User	getCurrentUser() Returns the current User.
Optional<User>	getCurrentUserIfAuthenticated() Returns the current User, if authenticated.
Optional<User>	getMockedUser() Returns a mocked User, if the environment variable "USE_MOCKED_USER" is set to "true".
protected abstract User	newMockedUser() Instantiates a mocked User.
io.vavr.control.Try<User>	tryGetCurrentUser() Returns a Try for the current User.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cloud.sdk.cloudplatform.security.user.UserFacade

getUserByName, getUserClass, resolveCurrentUser

Constructor Detail

AbstractUserFacade

public AbstractUserFacade()

Method Detail

newMockedUser

@Nonnull
protected abstract User newMockedUser()

Instantiates a mocked User.

Returns:

A new mocked User.

getMockedUser

@Nonnull
public Optional<User> getMockedUser()

Returns a mocked User, if the environment variable "USE_MOCKED_USER" is set to "true".

Returns:

The mocked User, if present.

getCurrentUser

@Nonnull
public User getCurrentUser()
                             throws UserNotAuthenticatedException,
                                    UserAccessException

Returns the current User.

Specified by:

getCurrentUser in interface UserFacade

Returns:

The current User.

Throws:

UserNotAuthenticatedException - If the User is currently not authenticated. This typically occurs when trying to access the user within code that is running outside the context of a request, e.g., within a background task. For more details on how user authentication is defined, refer to UserFacade.getCurrentUserIfAuthenticated().

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

getCurrentUserIfAuthenticated

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

Returns the current User, if authenticated.

The user authentication is defined as follows:

	User authenticated	User not authenticated
SAP Cloud Platform Cloud Foundry	A request is present with an "Authorization" header that contains a valid JWT bearer with field "user_name".	A request is not available, no "Authorization" header is present in the current request, or the JWT bearer does not hold a field "user_name".
SAP Cloud Platform Neo	A request is present that holds an authenticated principal according to the UserProvider API.	A request is not available or the user is not authenticated according to the UserProvider API.

Specified by:

getCurrentUserIfAuthenticated in interface UserFacade

Returns:

An Optional of the current User.

Throws:

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

See Also:

SAP Cloud Platform Neo - UserProvider API

tryGetCurrentUser

@Nonnull
public io.vavr.control.Try<User> tryGetCurrentUser()

Returns a Try for the current User.

Specified by:

tryGetCurrentUser in interface UserFacade

Returns:

A Try for the current User.