Class OidcLogoutConfigurer<B extends HttpSecurityBuilder<B>>
java.lang.Object
org.springframework.security.config.annotation.SecurityConfigurerAdapter<DefaultSecurityFilterChain,B>
org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer<OidcLogoutConfigurer<B>,B>
org.springframework.security.config.annotation.web.configurers.oauth2.client.OidcLogoutConfigurer<B>
- All Implemented Interfaces:
SecurityConfigurer<DefaultSecurityFilterChain,
B>
public final class OidcLogoutConfigurer<B extends HttpSecurityBuilder<B>>
extends AbstractHttpConfigurer<OidcLogoutConfigurer<B>,B>
An
AbstractHttpConfigurer
for OIDC Logout flows
OIDC Logout provides an application with the capability to have users log out by using their existing account at an OAuth 2.0 or OpenID Connect 1.0 Provider.
Security Filters
The followingFilter
is populated:
OidcBackChannelLogoutFilter
Shared Objects Used
The following shared objects are used:- Since:
- 6.2
- See Also:
-
HttpSecurity.oidcLogout()
OidcBackChannelLogoutFilter
ClientRegistrationRepository
-
Nested Class Summary
Modifier and TypeClassDescriptionfinal class
A configurer for configuring OIDC Back-Channel Logout -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionand()
Deprecated, for removal: This API element is subject to removal in a future version.backChannel
(Customizer<OidcLogoutConfigurer<B>.BackChannelLogoutConfigurer> backChannelLogoutConfigurer) Configure OIDC Back-Channel Logout using the providedConsumer
clientRegistrationRepository
(ClientRegistrationRepository clientRegistrationRepository) Sets the repository of client registrations.void
Configure theSecurityBuilder
by setting the necessary properties on theSecurityBuilder
.oidcSessionRegistry
(OidcSessionRegistry oidcSessionRegistry) Sets the registry for managing the OIDC client-provider session linkMethods inherited from class org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer
disable, getSecurityContextHolderStrategy, withObjectPostProcessor
Methods inherited from class org.springframework.security.config.annotation.SecurityConfigurerAdapter
addObjectPostProcessor, getBuilder, init, postProcess, setBuilder
-
Constructor Details
-
OidcLogoutConfigurer
public OidcLogoutConfigurer()
-
-
Method Details
-
clientRegistrationRepository
public OidcLogoutConfigurer<B> clientRegistrationRepository(ClientRegistrationRepository clientRegistrationRepository) Sets the repository of client registrations.- Parameters:
clientRegistrationRepository
- the repository of client registrations- Returns:
- the
OAuth2LoginConfigurer
for further configuration
-
oidcSessionRegistry
Sets the registry for managing the OIDC client-provider session link- Parameters:
oidcSessionRegistry
- theOidcSessionRegistry
to use- Returns:
- the
OAuth2LoginConfigurer
for further configuration
-
backChannel
public OidcLogoutConfigurer<B> backChannel(Customizer<OidcLogoutConfigurer<B>.BackChannelLogoutConfigurer> backChannelLogoutConfigurer) Configure OIDC Back-Channel Logout using the providedConsumer
- Returns:
- the
OidcLogoutConfigurer
for further configuration
-
and
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from class:SecurityConfigurerAdapter
Return theSecurityBuilder
when done using theSecurityConfigurer
. This is useful for method chaining.- Overrides:
and
in classSecurityConfigurerAdapter<DefaultSecurityFilterChain,
B extends HttpSecurityBuilder<B>> - Returns:
- the
SecurityBuilder
for further customizations
-
configure
Description copied from interface:SecurityConfigurer
Configure theSecurityBuilder
by setting the necessary properties on theSecurityBuilder
.- Specified by:
configure
in interfaceSecurityConfigurer<DefaultSecurityFilterChain,
B extends HttpSecurityBuilder<B>> - Overrides:
configure
in classSecurityConfigurerAdapter<DefaultSecurityFilterChain,
B extends HttpSecurityBuilder<B>> - Throws:
Exception
-