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

Class OAuth2TokenRevocationEndpointConfigurer

java.lang.Object

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

public final class OAuth2TokenRevocationEndpointConfigurer
extends Object

Configurer for the OAuth 2.0 Token Revocation Endpoint.

Since:

7.0

See Also:

• OAuth2AuthorizationServerConfigurer.tokenRevocationEndpoint(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OAuth2TokenRevocationEndpointConfigurer>)
• OAuth2TokenRevocationEndpointFilter

Method Summary

Modifier and Type	Method	Description
OAuth2TokenRevocationEndpointConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating a type of OAuth2TokenRevocationAuthenticationToken.
OAuth2TokenRevocationEndpointConfigurer	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.
OAuth2TokenRevocationEndpointConfigurer	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)
OAuth2TokenRevocationEndpointConfigurer	revocationRequestConverter(AuthenticationConverter revocationRequestConverter)	Adds an AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest to an instance of OAuth2TokenRevocationAuthenticationToken used for authenticating the request.
OAuth2TokenRevocationEndpointConfigurer	revocationRequestConverters(Consumer<List<AuthenticationConverter>> revocationRequestConvertersConsumer)	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.
OAuth2TokenRevocationEndpointConfigurer	revocationResponseHandler(AuthenticationSuccessHandler revocationResponseHandler)	Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken.

Methods inherited from class java.lang.Object

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

Method Details

revocationRequestConverter

public OAuth2TokenRevocationEndpointConfigurer revocationRequestConverter(AuthenticationConverter revocationRequestConverter)

Adds an AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest to an instance of OAuth2TokenRevocationAuthenticationToken used for authenticating the request.

Parameters:

revocationRequestConverter - an AuthenticationConverter used when attempting to extract a Revoke Token Request from HttpServletRequest

Returns:

the OAuth2TokenRevocationEndpointConfigurer for further configuration

revocationRequestConverters

public OAuth2TokenRevocationEndpointConfigurer revocationRequestConverters(Consumer<List<AuthenticationConverter>> revocationRequestConvertersConsumer)

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:

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

Returns:

the OAuth2TokenRevocationEndpointConfigurer for further configuration

authenticationProvider

public OAuth2TokenRevocationEndpointConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating a type of OAuth2TokenRevocationAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating a type of OAuth2TokenRevocationAuthenticationToken

Returns:

the OAuth2TokenRevocationEndpointConfigurer for further configuration

authenticationProviders

public OAuth2TokenRevocationEndpointConfigurer 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 OAuth2TokenRevocationEndpointConfigurer for further configuration

revocationResponseHandler

public OAuth2TokenRevocationEndpointConfigurer revocationResponseHandler(AuthenticationSuccessHandler revocationResponseHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken.

Parameters:

revocationResponseHandler - the AuthenticationSuccessHandler used for handling an OAuth2TokenRevocationAuthenticationToken

Returns:

the OAuth2TokenRevocationEndpointConfigurer for further configuration

errorResponseHandler

public OAuth2TokenRevocationEndpointConfigurer 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 OAuth2TokenRevocationEndpointConfigurer for further configuration

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()