org.springframework.security.oauth2.client.oidc.web.server.logout

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 and Description
OidcClientInitiatedServerLogoutSuccessHandler(ReactiveClientRegistrationRepository clientRegistrationRepository) Constructs an OidcClientInitiatedServerLogoutSuccessHandler with the provided parameters

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<java.lang.Void>	onLogoutSuccess(WebFilterExchange exchange, Authentication authentication) Invoked after log out was successful
void	setLogoutSuccessUrl(java.net.URI logoutSuccessUrl) The URL to redirect to after successfully logging out when not originally an OIDC login
void	setPostLogoutRedirectUri(java.lang.String postLogoutRedirectUri) Set the post logout redirect uri template to use.
void	setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri) Deprecated. setPostLogoutRedirectUri(String)

Methods inherited from class java.lang.Object

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

Constructor Detail

OidcClientInitiatedServerLogoutSuccessHandler

public OidcClientInitiatedServerLogoutSuccessHandler(ReactiveClientRegistrationRepository clientRegistrationRepository)

Constructs an OidcClientInitiatedServerLogoutSuccessHandler with the provided parameters

Parameters:

clientRegistrationRepository - The ReactiveClientRegistrationRepository 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)

Description copied from interface: ServerLogoutSuccessHandler

Invoked after log out was successful

Specified by:

onLogoutSuccess in interface ServerLogoutSuccessHandler

Parameters:

exchange - the exchange

authentication - the Authentication

Returns:

a completion notification (success or error)

setPostLogoutRedirectUri

@Deprecated
public void setPostLogoutRedirectUri(java.net.URI postLogoutRedirectUri)

Deprecated. setPostLogoutRedirectUri(String)

Set the post logout redirect uri to use

Parameters:

postLogoutRedirectUri - - A valid URL to which the OP should redirect after logging out the user

setPostLogoutRedirectUri

public void setPostLogoutRedirectUri(java.lang.String postLogoutRedirectUri)

Set the post logout redirect uri template to use. Supports the "{baseUrl}" placeholder, for example:

        handler.setPostLogoutRedirectUri("{baseUrl}");
 

will make so that post_logout_redirect_uri will be set to the base url for the client application.

Parameters:

postLogoutRedirectUri - - A template for creating the post_logout_redirect_uri query parameter

Since:

5.3

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".