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

Class ScpNeoUserFacade

java.lang.Object

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

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

All Implemented Interfaces:

UserFacade, WithRuntimeDependencies

public class ScpNeoUserFacade
extends AbstractUserFacade
implements WithRuntimeDependencies

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

Constructor Summary

Constructors

Constructor and Description
ScpNeoUserFacade()

Method Summary

Modifier and Type	Method and Description
void	assertRuntimeDependenciesExist() Asserts that required runtime dependencies are available on the class path.
Optional<User>	getUserByName(String name) Returns a User by its name, if it exists.
Class<ScpNeoUser>	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

Constructor Detail

ScpNeoUserFacade

public ScpNeoUserFacade()

Method Detail

getUserClass

@Nonnull
public Class<ScpNeoUser> getUserClass()

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

Specified by:

getUserClass in interface UserFacade

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.

assertRuntimeDependenciesExist

public void assertRuntimeDependenciesExist()
                                    throws DependencyNotFoundException

Asserts that required runtime dependencies are available on the class path.

Specified by:

assertRuntimeDependenciesExist in interface WithRuntimeDependencies

Throws:

DependencyNotFoundException - If a required runtime dependency is not available.

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.

Specified by:

resolveCurrentUser in interface UserFacade

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(@Nullable
                                             String name)
                                      throws UserAccessDeniedException,
                                             UserAccessException

Returns a User by its name, if it exists.

Specified by:

getUserByName in interface UserFacade

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.