Package org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization

Class OAuth2TokenEndpointConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2TokenEndpointConfigurer

public final class OAuth2TokenEndpointConfigurer
extends Object

Configurer for the OAuth 2.0 Token Endpoint.

Since:

7.0

See Also:

• OAuth2AuthorizationServerConfigurer.tokenEndpoint(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2TokenEndpointConfigurer>)
• OAuth2TokenEndpointFilter

Method Summary

Modifier and Type	Method	Description
OAuth2TokenEndpointConfigurer	accessTokenRequestConverter(AuthenticationConverter accessTokenRequestConverter)	Adds an AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest to an instance of OAuth2AuthorizationGrantAuthenticationToken used for authenticating the authorization grant.
OAuth2TokenEndpointConfigurer	accessTokenRequestConverters(Consumer<List<AuthenticationConverter>> accessTokenRequestConvertersConsumer)	Sets the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's allowing the ability to add, remove, or customize a specific AuthenticationConverter.
OAuth2TokenEndpointConfigurer	accessTokenResponseHandler(AuthenticationSuccessHandler accessTokenResponseHandler)	Sets the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken and returning the Access Token Response.
OAuth2TokenEndpointConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating a type of OAuth2AuthorizationGrantAuthenticationToken.
OAuth2TokenEndpointConfigurer	authenticationProviders(Consumer<List<AuthenticationProvider>> authenticationProvidersConsumer)	Sets the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's allowing the ability to add, remove, or customize a specific AuthenticationProvider.
OAuth2TokenEndpointConfigurer	errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
protected final ObjectPostProcessor<Object>	getObjectPostProcessor()
protected final <T> T	postProcess(T object)

Methods inherited from class java.lang.Object

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

Method Details

accessTokenRequestConverter

public OAuth2TokenEndpointConfigurer accessTokenRequestConverter(AuthenticationConverter accessTokenRequestConverter)

Adds an AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest to an instance of OAuth2AuthorizationGrantAuthenticationToken used for authenticating the authorization grant.

Parameters:

accessTokenRequestConverter - an AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

accessTokenRequestConverters

public OAuth2TokenEndpointConfigurer accessTokenRequestConverters(Consumer<List<AuthenticationConverter>> accessTokenRequestConvertersConsumer)

Sets the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's allowing the ability to add, remove, or customize a specific AuthenticationConverter.

Parameters:

accessTokenRequestConvertersConsumer - the Consumer providing access to the List of default and (optionally) added AuthenticationConverter's

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

authenticationProvider

public OAuth2TokenEndpointConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating a type of OAuth2AuthorizationGrantAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating a type of OAuth2AuthorizationGrantAuthenticationToken

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

authenticationProviders

public OAuth2TokenEndpointConfigurer authenticationProviders(Consumer<List<AuthenticationProvider>> authenticationProvidersConsumer)

Sets the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's allowing the ability to add, remove, or customize a specific AuthenticationProvider.

Parameters:

authenticationProvidersConsumer - the Consumer providing access to the List of default and (optionally) added AuthenticationProvider's

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

accessTokenResponseHandler

public OAuth2TokenEndpointConfigurer accessTokenResponseHandler(AuthenticationSuccessHandler accessTokenResponseHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken and returning the Access Token Response.

Parameters:

accessTokenResponseHandler - the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

errorResponseHandler

public OAuth2TokenEndpointConfigurer errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)

Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.

Parameters:

errorResponseHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException

Returns:

the OAuth2TokenEndpointConfigurer for further configuration

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()