com.sap.cloud.sdk.cloudplatform.security

Class AuthTokenAccessor

java.lang.Object

com.sap.cloud.sdk.cloudplatform.security.AuthTokenAccessor

public final class AuthTokenAccessor
extends Object

Accessor for retrieving the current AuthToken on SAP Cloud Platform Cloud Foundry.

Method Summary

Modifier and Type	Method and Description
static <T> T	executeWithAuthToken(AuthToken authToken, Callable<T> callable) Execute the given Callable with a given token.
static void	executeWithAuthToken(AuthToken authToken, Executable executable) Execute the given Executable with a given token.
static <T> T	executeWithFallbackAuthToken(Supplier<AuthToken> fallbackAuthToken, Callable<T> callable) Execute the given Callable, using the given token as fallback if there is no other token available.
static void	executeWithFallbackAuthToken(Supplier<AuthToken> fallbackAuthToken, Executable executable) Execute the given Executable, using the given token as fallback if there is no other token available.
static AuthTokenFacade	getAuthTokenFacade() The AuthTokenFacade instance.
static AuthToken	getCurrentToken() Returns the current AuthToken.
static Supplier<AuthToken>	getFallbackToken() Global fallback AuthToken.
static Future<String>	getRefreshToken(com.auth0.jwt.interfaces.DecodedJWT jwt) Returns a Future that resolves to a refresh token.
static AuthToken	getXsuaaServiceToken() Retrieves a validated authentication token from the bound XSUAA instance.
static void	setAuthTokenFacade(AuthTokenFacade requestFacade) Replaces the default AuthTokenFacade instance.
static void	setFallbackToken(Supplier<AuthToken> fallbackToken) Global fallback AuthToken.
static io.vavr.control.Try<AuthToken>	tryGetCurrentToken() Returns a Try of the current AuthToken, or, if the Try is a failure, the global fallback.
static io.vavr.control.Try<AuthToken>	tryGetXsuaaServiceToken() Retrieves a validated authentication token from the bound XSUAA instance.

Methods inherited from class java.lang.Object

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

Method Detail

setAuthTokenFacade

public static void setAuthTokenFacade(@Nullable
                                      AuthTokenFacade requestFacade)

Replaces the default AuthTokenFacade instance.

Parameters:

requestFacade - An instance of AuthTokenFacade. Use null to reset the facade.

getCurrentToken

@Nonnull
public static AuthToken getCurrentToken()
                                          throws AuthTokenAccessException

Returns the current AuthToken.

Returns:

The current AuthToken.

Throws:

AuthTokenAccessException - If there is an issue while trying to access the AuthToken. For instance, an AuthToken is not available if no request is available or the request does not contain an "Authorization" header.

tryGetCurrentToken

@Nonnull
public static io.vavr.control.Try<AuthToken> tryGetCurrentToken()

Returns a Try of the current AuthToken, or, if the Try is a failure, the global fallback. An AuthToken is not available if no request is available or the request does not contain an "Authorization" header.

Returns:

A Try of the current AuthToken

getXsuaaServiceToken

@Nonnull
public static AuthToken getXsuaaServiceToken()
                                               throws TokenRequestFailedException

Retrieves a validated authentication token from the bound XSUAA instance.

Returns:

A Try of the XSUAA authentication token.

Throws:

TokenRequestFailedException - If no XSUAA instance was bound or the communication with the service failed.

tryGetXsuaaServiceToken

@Nonnull
public static io.vavr.control.Try<AuthToken> tryGetXsuaaServiceToken()

Retrieves a validated authentication token from the bound XSUAA instance.

Returns:

A Try of the XSUAA authentication token.

getRefreshToken

@Nonnull
public static Future<String> getRefreshToken(@Nonnull
                                                      com.auth0.jwt.interfaces.DecodedJWT jwt)

Returns a Future that resolves to a refresh token.

Parameters:

jwt - The decoded JWT instance to resolve a refresh token for.

Returns:

A Future that resolves to a refresh token.

Throws:

TokenRequestFailedException - When the token request failed.

TokenRequestDeniedException - When the token request was denied.

executeWithAuthToken

@Nullable
public static <T> T executeWithAuthToken(@Nonnull
                                                   AuthToken authToken,
                                                   @Nonnull
                                                   Callable<T> callable)
                                            throws ThreadContextExecutionException

Execute the given Callable with a given token.

Type Parameters:

T - The type of the callable.

Parameters:

authToken - The token to execute with.

callable - The callable to execute.

Returns:

The value computed by the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the token.

executeWithAuthToken

public static void executeWithAuthToken(@Nonnull
                                        AuthToken authToken,
                                        @Nonnull
                                        Executable executable)
                                 throws ThreadContextExecutionException

Execute the given Executable with a given token.

Parameters:

authToken - The token to execute with.

executable - The executable to execute.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the token.

executeWithFallbackAuthToken

@Nullable
public static <T> T executeWithFallbackAuthToken(@Nonnull
                                                           Supplier<AuthToken> fallbackAuthToken,
                                                           @Nonnull
                                                           Callable<T> callable)
                                                    throws ThreadContextExecutionException

Execute the given Callable, using the given token as fallback if there is no other token available.

Type Parameters:

T - The type of the callable.

Parameters:

fallbackAuthToken - The token to fall back to.

callable - The callable to execute.

Returns:

The value computed by the callable.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the token.

executeWithFallbackAuthToken

public static void executeWithFallbackAuthToken(@Nonnull
                                                Supplier<AuthToken> fallbackAuthToken,
                                                @Nonnull
                                                Executable executable)
                                         throws ThreadContextExecutionException

Execute the given Executable, using the given token as fallback if there is no other token available.

Parameters:

fallbackAuthToken - The token to fall back to.

executable - The executable to execute.

Throws:

ThreadContextExecutionException - If there is an issue while running the code with the token.

getAuthTokenFacade

@Nonnull
public static AuthTokenFacade getAuthTokenFacade()

The AuthTokenFacade instance.

getFallbackToken

@Nullable
public static Supplier<AuthToken> getFallbackToken()

Global fallback AuthToken. By default, no fallback is used, i.e., the fallback is null. A global fallback can be useful to ensure a safe fallback or to ease testing with a mocked token.

setFallbackToken

public static void setFallbackToken(@Nullable
                                    Supplier<AuthToken> fallbackToken)

Global fallback AuthToken. By default, no fallback is used, i.e., the fallback is null. A global fallback can be useful to ensure a safe fallback or to ease testing with a mocked token.