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

Class OidcLogoutEndpointConfigurer

java.lang.Object

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

public final class OidcLogoutEndpointConfigurer
extends Object

Configurer for OpenID Connect 1.0 RP-Initiated Logout Endpoint.

Since:

7.0

See Also:

• OidcConfigurer.logoutEndpoint(org.springframework.security.config.Customizer<org.springframework.security.config.annotation.web.configurers.oauth2.server.authorization.OidcLogoutEndpointConfigurer>)
• OidcLogoutEndpointFilter

Method Summary

Modifier and Type	Method	Description
OidcLogoutEndpointConfigurer	authenticationProvider(AuthenticationProvider authenticationProvider)	Adds an AuthenticationProvider used for authenticating an OidcLogoutAuthenticationToken.
OidcLogoutEndpointConfigurer	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.
OidcLogoutEndpointConfigurer	errorResponseHandler(AuthenticationFailureHandler errorResponseHandler)	Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
protected final ObjectPostProcessor<Object>	getObjectPostProcessor()
OidcLogoutEndpointConfigurer	logoutRequestConverter(AuthenticationConverter logoutRequestConverter)	Adds an AuthenticationConverter used when attempting to extract a Logout Request from HttpServletRequest to an instance of OidcLogoutAuthenticationToken used for authenticating the request.
OidcLogoutEndpointConfigurer	logoutRequestConverters(Consumer<List<AuthenticationConverter>> logoutRequestConvertersConsumer)	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.
OidcLogoutEndpointConfigurer	logoutResponseHandler(AuthenticationSuccessHandler logoutResponseHandler)	Sets the AuthenticationSuccessHandler used for handling an OidcLogoutAuthenticationToken and performing the logout.
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

logoutRequestConverter

public OidcLogoutEndpointConfigurer logoutRequestConverter(AuthenticationConverter logoutRequestConverter)

Adds an AuthenticationConverter used when attempting to extract a Logout Request from HttpServletRequest to an instance of OidcLogoutAuthenticationToken used for authenticating the request.

Parameters:

logoutRequestConverter - an AuthenticationConverter used when attempting to extract a Logout Request from HttpServletRequest

Returns:

the OidcLogoutEndpointConfigurer for further configuration

logoutRequestConverters

public OidcLogoutEndpointConfigurer logoutRequestConverters(Consumer<List<AuthenticationConverter>> logoutRequestConvertersConsumer)

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:

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

Returns:

the OidcLogoutEndpointConfigurer for further configuration

authenticationProvider

public OidcLogoutEndpointConfigurer authenticationProvider(AuthenticationProvider authenticationProvider)

Adds an AuthenticationProvider used for authenticating an OidcLogoutAuthenticationToken.

Parameters:

authenticationProvider - an AuthenticationProvider used for authenticating an OidcLogoutAuthenticationToken

Returns:

the OidcLogoutEndpointConfigurer for further configuration

authenticationProviders

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

logoutResponseHandler

public OidcLogoutEndpointConfigurer logoutResponseHandler(AuthenticationSuccessHandler logoutResponseHandler)

Sets the AuthenticationSuccessHandler used for handling an OidcLogoutAuthenticationToken and performing the logout.

Parameters:

logoutResponseHandler - the AuthenticationSuccessHandler used for handling an OidcLogoutAuthenticationToken

Returns:

the OidcLogoutEndpointConfigurer for further configuration

errorResponseHandler

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

postProcess

protected final <T> T postProcess(T object)

getObjectPostProcessor

protected final ObjectPostProcessor<Object> getObjectPostProcessor()