Saml2RelyingPartyInitiatedLogoutSuccessHandler (spring-security-docs 5.6.7 API)

java.lang.Object
- org.springframework.security.saml2.provider.service.web.authentication.logout.Saml2RelyingPartyInitiatedLogoutSuccessHandler

All Implemented Interfaces:

LogoutSuccessHandler
```
public final class Saml2RelyingPartyInitiatedLogoutSuccessHandler
extends java.lang.Object
implements LogoutSuccessHandler
```
A success handler for issuing a SAML 2.0 Logout Request to the the SAML 2.0 Asserting Party

Since:

5.6

Constructor Summary

Constructors
Constructor	Description
`Saml2RelyingPartyInitiatedLogoutSuccessHandler(Saml2LogoutRequestResolver logoutRequestResolver)`	Constructs a `Saml2RelyingPartyInitiatedLogoutSuccessHandler` using the provided parameters

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`onLogoutSuccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication authentication)`	Produce and send a SAML 2.0 Logout Response based on the SAML 2.0 Logout Request received from the asserting party
`void`	`setLogoutRequestRepository(Saml2LogoutRequestRepository logoutRequestRepository)`	Use this `Saml2LogoutRequestRepository` for saving the SAML 2.0 Logout Request

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Saml2RelyingPartyInitiatedLogoutSuccessHandler
```
public Saml2RelyingPartyInitiatedLogoutSuccessHandler(Saml2LogoutRequestResolver logoutRequestResolver)
```
    Constructs a Saml2RelyingPartyInitiatedLogoutSuccessHandler using the provided parameters
    
    Parameters:
    
    logoutRequestResolver - the Saml2LogoutRequestResolver to use
- Method Detail
  - onLogoutSuccess
```
public void onLogoutSuccess(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            Authentication authentication)
                     throws java.io.IOException
```
    Produce and send a SAML 2.0 Logout Response based on the SAML 2.0 Logout Request received from the asserting party
    
    Specified by:
    
    onLogoutSuccess in interface LogoutSuccessHandler
    
    Parameters:
    
    request - the HTTP request
    
    response - the HTTP response
    
    authentication - the current principal details
    
    Throws:
    
    java.io.IOException - when failing to write to the response
  - setLogoutRequestRepository
```
public void setLogoutRequestRepository(Saml2LogoutRequestRepository logoutRequestRepository)
```
    Use this Saml2LogoutRequestRepository for saving the SAML 2.0 Logout Request
    
    Parameters:
    
    logoutRequestRepository - the Saml2LogoutRequestRepository to use