com.sap.cloud.sdk.cloudplatform.security

Class AuthTokenAccessor

java.lang.Object

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

public class AuthTokenAccessor
extends Object

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

Constructor Summary

Constructors

Constructor and Description
AuthTokenAccessor()

Method Summary

Modifier and Type	Method and Description
static AuthTokenFacade	getAuthTokenFacade()
static Optional<AuthToken>	getCurrentToken() Returns the current AuthToken, if present.
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 authTokenFacade) Replaces the default AuthTokenFacade instance.
static void	setRefreshTokenFacade(RefreshTokenFacade refreshTokenFacade) Replaces the default RefreshTokenFacade instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthTokenAccessor

public AuthTokenAccessor()

Method Detail

getAuthTokenFacade

@Nonnull
public static AuthTokenFacade getAuthTokenFacade()

Returns:

The AuthTokenFacade instance. This method is for internal use only.

setAuthTokenFacade

public static void setAuthTokenFacade(@Nonnull
                                      AuthTokenFacade authTokenFacade)

Replaces the default AuthTokenFacade instance. This method is for internal use only.

Parameters:

authTokenFacade - An instance of AuthTokenFacade.

setRefreshTokenFacade

public static void setRefreshTokenFacade(@Nonnull
                                         RefreshTokenFacade refreshTokenFacade)

Replaces the default RefreshTokenFacade instance. This method is for internal use only.

Parameters:

refreshTokenFacade - An instance of RefreshTokenFacade.

getCurrentToken

@Nonnull
public static Optional<AuthToken> getCurrentToken()
                                                    throws AuthTokenAccessException

Returns the current AuthToken, if present. An AuthToken is not present if no request is available or the request does not contain an "Authorization" header.

Returns:

An Optional of the current AuthToken.

Throws:

AuthTokenAccessException - If there is an issue while trying to access the AuthToken.

getXsuaaServiceToken

@Nonnull
public static AuthToken getXsuaaServiceToken()
                                               throws TokenRequestFailedException

Retrieves a validated authentication token from the bound XSUAA instance.

Returns:

An authentication token from the XSUAA instance.

Throws:

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

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 JWT for which to retrieve a refresh token.

Returns:

A future that resolves to a refresh token.