Class OidcClientInitiatedServerLogoutSuccessHandler
- java.lang.Object
-
- org.springframework.security.oauth2.client.oidc.web.server.logout.OidcClientInitiatedServerLogoutSuccessHandler
-
- All Implemented Interfaces:
ServerLogoutSuccessHandler
public class OidcClientInitiatedServerLogoutSuccessHandler extends java.lang.Object implements ServerLogoutSuccessHandler
A reactive logout success handler for initiating OIDC logout through the user agent.- Since:
- 5.2
- See Also:
- RP-Initiated Logout,
ServerLogoutSuccessHandler
-
-
Constructor Summary
Constructors Constructor Description OidcClientInitiatedServerLogoutSuccessHandler(ReactiveClientRegistrationRepository clientRegistrationRepository)
Constructs anOidcClientInitiatedServerLogoutSuccessHandler
with the provided parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description reactor.core.publisher.Mono<java.lang.Void>
onLogoutSuccess(WebFilterExchange exchange, Authentication authentication)
Invoked after log out was successfulvoid
setLogoutSuccessUrl(java.net.URI logoutSuccessUrl)
The URL to redirect to after successfully logging out when not originally an OIDC loginvoid
setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri)
Set the post logout redirect uri to use
-
-
-
Constructor Detail
-
OidcClientInitiatedServerLogoutSuccessHandler
public OidcClientInitiatedServerLogoutSuccessHandler(ReactiveClientRegistrationRepository clientRegistrationRepository)
Constructs anOidcClientInitiatedServerLogoutSuccessHandler
with the provided parameters- Parameters:
clientRegistrationRepository
- TheReactiveClientRegistrationRepository
to use to derive the end_session_endpoint value
-
-
Method Detail
-
onLogoutSuccess
public reactor.core.publisher.Mono<java.lang.Void> onLogoutSuccess(WebFilterExchange exchange, Authentication authentication)
Invoked after log out was successful- Specified by:
onLogoutSuccess
in interfaceServerLogoutSuccessHandler
- Parameters:
exchange
- the exchangeauthentication
- theAuthentication
- Returns:
- a completion notification (success or error)
-
setPostLogoutRedirectUri
public void setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri)
Set the post logout redirect uri to use- Parameters:
postLogoutRedirectUri
- - A valid URL to which the OP should redirect after logging out the user
-
setLogoutSuccessUrl
public void setLogoutSuccessUrl(java.net.URI logoutSuccessUrl)
The URL to redirect to after successfully logging out when not originally an OIDC login- Parameters:
logoutSuccessUrl
- the url to redirect to. Default is "/login?logout".
-
-