Class OidcLogoutAuthenticationSuccessHandler

java.lang.Object

org.springframework.security.oauth2.server.authorization.oidc.web.authentication.OidcLogoutAuthenticationSuccessHandler

All Implemented Interfaces:

AuthenticationSuccessHandler

public final class OidcLogoutAuthenticationSuccessHandler
extends Object
implements AuthenticationSuccessHandler

An implementation of an AuthenticationSuccessHandler used for handling an OidcLogoutAuthenticationToken and performing the OpenID Connect 1.0 RP-Initiated Logout.

Since:

7.0

See Also:

• OidcLogoutEndpointFilter.setAuthenticationSuccessHandler(AuthenticationSuccessHandler)
• LogoutHandler

Constructor Summary

Constructors

Constructor	Description
OidcLogoutAuthenticationSuccessHandler()

Method Summary

Modifier and Type	Method	Description
void	onAuthenticationSuccess(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Authentication authentication)	Called when a user has been successfully authenticated.
void	setLogoutHandler(LogoutHandler logoutHandler)	Sets the LogoutHandler used for performing logout.

Methods inherited from class Object

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

Methods inherited from interface AuthenticationSuccessHandler

onAuthenticationSuccess

Constructor Details

OidcLogoutAuthenticationSuccessHandler

public OidcLogoutAuthenticationSuccessHandler()

Method Details

onAuthenticationSuccess

public void onAuthenticationSuccess(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Authentication authentication)
                             throws IOException,
jakarta.servlet.ServletException

Description copied from interface: AuthenticationSuccessHandler

Called when a user has been successfully authenticated.

Specified by:

onAuthenticationSuccess in interface AuthenticationSuccessHandler

Parameters:

request - the request which caused the successful authentication

response - the response

authentication - the Authentication object which was created during the authentication process.

Throws:

IOException

jakarta.servlet.ServletException

setLogoutHandler

public void setLogoutHandler(LogoutHandler logoutHandler)

Sets the LogoutHandler used for performing logout.

Parameters:

logoutHandler - the LogoutHandler used for performing logout