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

Interface Saml2LogoutResponseResolver

public interface Saml2LogoutResponseResolver

Creates a signed SAML 2.0 Logout Response based on information from the HttpServletRequest and current Authentication. The returned logout response is suitable for sending to the asserting party based on, for example, the location and binding specified in RelyingPartyRegistration.getAssertingPartyMetadata().

Since:

5.6

See Also:

• RelyingPartyRegistration

Method Summary

Modifier and Type	Method	Description
Saml2LogoutResponse	resolve(jakarta.servlet.http.HttpServletRequest request, Authentication authentication)	Prepare to create, sign, and serialize a SAML 2.0 Logout Response.
default Saml2LogoutResponse	resolve(jakarta.servlet.http.HttpServletRequest request, Authentication authentication, Saml2AuthenticationException authenticationException)	Prepare to create, sign, and serialize a SAML 2.0 Error Logout Response.

Method Details

resolve

Saml2LogoutResponse resolve(jakarta.servlet.http.HttpServletRequest request,
 Authentication authentication)

Prepare to create, sign, and serialize a SAML 2.0 Logout Response.

Parameters:

request - the HTTP request

authentication - the current user

Returns:

a signed and serialized SAML 2.0 Logout Response

resolve

default Saml2LogoutResponse resolve(jakarta.servlet.http.HttpServletRequest request,
 Authentication authentication,
 Saml2AuthenticationException authenticationException)

Prepare to create, sign, and serialize a SAML 2.0 Error Logout Response.

Parameters:

request - the HTTP request

authentication - the current user

authenticationException - the thrown exception when the logout request was processed

Returns:

a signed and serialized SAML 2.0 Logout Response, or null if it cannot generate a SAML 2.0 Error Logout Response

Since:

7.0