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

Interface UserFacade

All Known Implementing Classes:

AbstractUserFacade, ScpCfUserFacade, ScpNeoUserFacade

public interface UserFacade

Facade interface encapsulating the logic to access User information.

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>	getUserByName(String name) Returns a User by its name, if it exists.
Class<? extends User>	getUserClass() Returns the platform-specific implementation class of User.
Optional<User>	resolveCurrentUser() Resolves the current User using the platform-specific lookup.
io.vavr.control.Try<User>	tryGetCurrentUser() Returns a Try for the current User.

Method Detail

getUserClass

@Nonnull
Class<? extends User> getUserClass()

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

Returns:

The type of the platform-specific implementation.

resolveCurrentUser

@Nonnull
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

getCurrentUser

@Nonnull
User getCurrentUser()
                      throws UserNotAuthenticatedException,
                             UserAccessException

Returns the current User.

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

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

getCurrentUserIfAuthenticated

@Nonnull
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.

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
io.vavr.control.Try<User> tryGetCurrentUser()

Returns a Try for the current User.

Returns:

A Try for the current User.

getUserByName

@Nonnull
Optional<User> getUserByName(@Nullable
                                      String name)
                               throws UserAccessDeniedException,
                                      UserAccessException

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.

Throws:

UserAccessDeniedException - If accessing user information is denied.

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