Package com.sap.cloud.security.servlet

Class XsuaaTokenAuthenticator

java.lang.Object

com.sap.cloud.security.servlet.AbstractTokenAuthenticator

com.sap.cloud.security.servlet.XsuaaTokenAuthenticator

All Implemented Interfaces:

TokenAuthenticator

public class XsuaaTokenAuthenticator
extends AbstractTokenAuthenticator

Field Summary

Fields inherited from class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

httpClient, serviceConfiguration

Constructor Summary

Constructors

Constructor	Description
XsuaaTokenAuthenticator()

Method Summary

Modifier and Type	Method	Description
protected TokenAuthenticationResult	authenticated(Token token)
Token	extractFromHeader(String authorizationHeader)	Extracts the Token from the authorization header.
protected OAuth2ServiceConfiguration	getOtherServiceConfiguration()	Return other configured service configurations or null if not configured.
protected OAuth2ServiceConfiguration	getServiceConfiguration()	Return configured service configuration or Environments.getCurrent() if not configured.
TokenAuthenticationResult	validateRequest(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
AbstractTokenAuthenticator	withHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)	Use to configure the HttpClient that is used to retrieve token keys or to perform a token-exchange.
AbstractTokenAuthenticator	withServiceConfiguration(OAuth2ServiceConfiguration serviceConfiguration)	Use to override the service configuration used.

Methods inherited from class com.sap.cloud.security.servlet.AbstractTokenAuthenticator

withCacheConfiguration, withValidationListener

Methods inherited from class java.lang.Object

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

Constructor Details

XsuaaTokenAuthenticator

public XsuaaTokenAuthenticator()

Method Details

withServiceConfiguration

public AbstractTokenAuthenticator withServiceConfiguration(OAuth2ServiceConfiguration serviceConfiguration)

Description copied from class: AbstractTokenAuthenticator

Use to override the service configuration used.

Overrides:

withServiceConfiguration in class AbstractTokenAuthenticator

Parameters:

serviceConfiguration - the service configuration to use

Returns:

this authenticator

withHttpClient

public AbstractTokenAuthenticator withHttpClient(org.apache.http.impl.client.CloseableHttpClient httpClient)

Description copied from class: AbstractTokenAuthenticator

Use to configure the HttpClient that is used to retrieve token keys or to perform a token-exchange.

Overrides:

withHttpClient in class AbstractTokenAuthenticator

Parameters:

httpClient - the HttpClient

Returns:

this authenticator

extractFromHeader

public Token extractFromHeader(String authorizationHeader)

Description copied from class: AbstractTokenAuthenticator

Extracts the Token from the authorization header.

Specified by:

extractFromHeader in class AbstractTokenAuthenticator

Parameters:

authorizationHeader - the value of the 'Authorization' request header

Returns:

the Token instance.

getServiceConfiguration

protected OAuth2ServiceConfiguration getServiceConfiguration()

Description copied from class: AbstractTokenAuthenticator

Return configured service configuration or Environments.getCurrent() if not configured.

Specified by:

getServiceConfiguration in class AbstractTokenAuthenticator

Returns:

the actual service configuration

getOtherServiceConfiguration

@Nullable
protected OAuth2ServiceConfiguration getOtherServiceConfiguration()

Description copied from class: AbstractTokenAuthenticator

Return other configured service configurations or null if not configured.

Specified by:

getOtherServiceConfiguration in class AbstractTokenAuthenticator

Returns:

the other service configuration or null

authenticated

protected TokenAuthenticationResult authenticated(Token token)

Overrides:

authenticated in class AbstractTokenAuthenticator

validateRequest

public TokenAuthenticationResult validateRequest(jakarta.servlet.ServletRequest request,
 jakarta.servlet.ServletResponse response)

Specified by:

validateRequest in interface TokenAuthenticator

Overrides:

validateRequest in class AbstractTokenAuthenticator