Package org.springframework.security.saml2.provider.service.web.authentication.logout

Interface Saml2LogoutRequestRepository

All Known Implementing Classes:

HttpSessionLogoutRequestRepository

public interface Saml2LogoutRequestRepository

Implementations of this interface are responsible for the persistence of Saml2LogoutRequest between requests.

Used by the Saml2RelyingPartyInitiatedLogoutSuccessHandler for persisting the Logout Request before it initiates the SAML 2.0 SLO flow. As well, used by OpenSamlLogoutResponseHandler for resolving the Logout Request associated with that Logout Response.

Since:

5.6

See Also:

Saml2LogoutRequest, HttpSessionLogoutRequestRepository

Method Summary

Modifier and Type	Method	Description
Saml2LogoutRequest	loadLogoutRequest(javax.servlet.http.HttpServletRequest request)	Returns the Saml2LogoutRequest associated to the provided HttpServletRequest or null if not available.
Saml2LogoutRequest	removeLogoutRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Removes and returns the Saml2LogoutRequest associated to the provided HttpServletRequest and HttpServletResponse or if not available returns null.
void	saveLogoutRequest(Saml2LogoutRequest logoutRequest, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)	Persists the Saml2LogoutRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

Method Detail

loadLogoutRequest

Saml2LogoutRequest loadLogoutRequest(javax.servlet.http.HttpServletRequest request)

Returns the Saml2LogoutRequest associated to the provided HttpServletRequest or null if not available.

Parameters:

request - the HttpServletRequest

Returns:

the Saml2LogoutRequest or null if not available

saveLogoutRequest

void saveLogoutRequest(Saml2LogoutRequest logoutRequest,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

Persists the Saml2LogoutRequest associating it to the provided HttpServletRequest and/or HttpServletResponse.

Parameters:

logoutRequest - the Saml2LogoutRequest

request - the HttpServletRequest

response - the HttpServletResponse

removeLogoutRequest

Saml2LogoutRequest removeLogoutRequest(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)

Removes and returns the Saml2LogoutRequest associated to the provided HttpServletRequest and HttpServletResponse or if not available returns null.

Parameters:

request - the HttpServletRequest

response - the HttpServletResponse

Returns:

the Saml2LogoutRequest or null if not available