Class OidcLogoutEndpointConfigurer
java.lang.Object
org.springframework.security.oauth2.server.authorization.config.annotation.web.configurers.OidcLogoutEndpointConfigurer
Configurer for OpenID Connect 1.0 RP-Initiated Logout Endpoint.
-
Method Summary
Modifier and TypeMethodDescriptionauthenticationProvider
(org.springframework.security.authentication.AuthenticationProvider authenticationProvider) Adds anAuthenticationProvider
used for authenticating anOidcLogoutAuthenticationToken
.authenticationProviders
(Consumer<List<org.springframework.security.authentication.AuthenticationProvider>> authenticationProvidersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's allowing the ability to add, remove, or customize a specificAuthenticationProvider
.errorResponseHandler
(org.springframework.security.web.authentication.AuthenticationFailureHandler errorResponseHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.protected final org.springframework.security.config.annotation.ObjectPostProcessor<Object>
logoutRequestConverter
(org.springframework.security.web.authentication.AuthenticationConverter logoutRequestConverter) Adds anAuthenticationConverter
used when attempting to extract a Logout Request fromHttpServletRequest
to an instance ofOidcLogoutAuthenticationToken
used for authenticating the request.logoutRequestConverters
(Consumer<List<org.springframework.security.web.authentication.AuthenticationConverter>> logoutRequestConvertersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's allowing the ability to add, remove, or customize a specificAuthenticationConverter
.logoutResponseHandler
(org.springframework.security.web.authentication.AuthenticationSuccessHandler logoutResponseHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcLogoutAuthenticationToken
and performing the logout.protected final <T> T
postProcess
(T object)
-
Method Details
-
logoutRequestConverter
public OidcLogoutEndpointConfigurer logoutRequestConverter(org.springframework.security.web.authentication.AuthenticationConverter logoutRequestConverter) Adds anAuthenticationConverter
used when attempting to extract a Logout Request fromHttpServletRequest
to an instance ofOidcLogoutAuthenticationToken
used for authenticating the request.- Parameters:
logoutRequestConverter
- anAuthenticationConverter
used when attempting to extract a Logout Request fromHttpServletRequest
- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
logoutRequestConverters
public OidcLogoutEndpointConfigurer logoutRequestConverters(Consumer<List<org.springframework.security.web.authentication.AuthenticationConverter>> logoutRequestConvertersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's allowing the ability to add, remove, or customize a specificAuthenticationConverter
.- Parameters:
logoutRequestConvertersConsumer
- theConsumer
providing access to theList
of default and (optionally) addedAuthenticationConverter
's- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
authenticationProvider
public OidcLogoutEndpointConfigurer authenticationProvider(org.springframework.security.authentication.AuthenticationProvider authenticationProvider) Adds anAuthenticationProvider
used for authenticating anOidcLogoutAuthenticationToken
.- Parameters:
authenticationProvider
- anAuthenticationProvider
used for authenticating anOidcLogoutAuthenticationToken
- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
authenticationProviders
public OidcLogoutEndpointConfigurer authenticationProviders(Consumer<List<org.springframework.security.authentication.AuthenticationProvider>> authenticationProvidersConsumer) Sets theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's allowing the ability to add, remove, or customize a specificAuthenticationProvider
.- Parameters:
authenticationProvidersConsumer
- theConsumer
providing access to theList
of default and (optionally) addedAuthenticationProvider
's- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
logoutResponseHandler
public OidcLogoutEndpointConfigurer logoutResponseHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler logoutResponseHandler) Sets theAuthenticationSuccessHandler
used for handling anOidcLogoutAuthenticationToken
and performing the logout.- Parameters:
logoutResponseHandler
- theAuthenticationSuccessHandler
used for handling anOidcLogoutAuthenticationToken
- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
errorResponseHandler
public OidcLogoutEndpointConfigurer errorResponseHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler errorResponseHandler) Sets theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
and returning theError Response
.- Parameters:
errorResponseHandler
- theAuthenticationFailureHandler
used for handling anOAuth2AuthenticationException
- Returns:
- the
OidcLogoutEndpointConfigurer
for further configuration
-
postProcess
protected final <T> T postProcess(T object) -
getObjectPostProcessor
protected final org.springframework.security.config.annotation.ObjectPostProcessor<Object> getObjectPostProcessor()
-