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

Class OpenSaml5LogoutResponseResolver

java.lang.Object

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

All Implemented Interfaces:

Saml2LogoutResponseResolver

public final class OpenSaml5LogoutResponseResolver
extends Object
implements Saml2LogoutResponseResolver

A Saml2LogoutResponseResolver for resolving SAML 2.0 Logout Responses with OpenSAML 5

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSaml5LogoutResponseResolver.LogoutResponseParameters

Constructor Summary

Constructors

Constructor	Description
OpenSaml5LogoutResponseResolver(RelyingPartyRegistrationRepository registrations)
OpenSaml5LogoutResponseResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)	Construct a OpenSaml5LogoutResponseResolver

Method Summary

Modifier and Type	Method	Description
Saml2LogoutResponse	resolve(jakarta.servlet.http.HttpServletRequest request, org.springframework.security.core.Authentication authentication)	Prepare to create, sign, and serialize a SAML 2.0 Logout Response.
Saml2LogoutResponse	resolve(jakarta.servlet.http.HttpServletRequest request, org.springframework.security.core.Authentication authentication, Saml2AuthenticationException exception)	Prepare to create, sign, and serialize a SAML 2.0 Error Logout Response.
void	setClock(Clock clock)	Use this Clock for determining the issued Instant
void	setParametersConsumer(Consumer<OpenSaml5LogoutResponseResolver.LogoutResponseParameters> parametersConsumer)	Set a Consumer for modifying the OpenSAML LogoutRequest

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSaml5LogoutResponseResolver

public OpenSaml5LogoutResponseResolver(RelyingPartyRegistrationRepository registrations)

OpenSaml5LogoutResponseResolver

public OpenSaml5LogoutResponseResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)

Construct a OpenSaml5LogoutResponseResolver

Method Details

resolve

public Saml2LogoutResponse resolve(jakarta.servlet.http.HttpServletRequest request,
 org.springframework.security.core.Authentication authentication)

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

Specified by:

resolve in interface Saml2LogoutResponseResolver

Parameters:

request - the HTTP request

authentication - the current user

Returns:

a signed and serialized SAML 2.0 Logout Response

resolve

public Saml2LogoutResponse resolve(jakarta.servlet.http.HttpServletRequest request,
 org.springframework.security.core.Authentication authentication,
 Saml2AuthenticationException exception)

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

Specified by:

resolve in interface Saml2LogoutResponseResolver

Parameters:

request - the HTTP request

authentication - the current user

exception - 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

setParametersConsumer

public void setParametersConsumer(Consumer<OpenSaml5LogoutResponseResolver.LogoutResponseParameters> parametersConsumer)

Set a Consumer for modifying the OpenSAML LogoutRequest

Parameters:

parametersConsumer - a consumer that accepts an OpenSaml5LogoutRequestResolver.LogoutRequestParameters

setClock

public void setClock(Clock clock)

Use this Clock for determining the issued Instant

Parameters:

clock - the Clock to use