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

Class OpenSaml4LogoutRequestResolver

java.lang.Object

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

All Implemented Interfaces:

Saml2LogoutRequestResolver

public final class OpenSaml4LogoutRequestResolver
extends Object
implements Saml2LogoutRequestResolver

A Saml2LogoutRequestResolver for resolving SAML 2.0 Logout Requests with OpenSAML 4

Since:

5.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSaml4LogoutRequestResolver.LogoutRequestParameters

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Saml2LogoutRequest	resolve(jakarta.servlet.http.HttpServletRequest request, Authentication authentication)	Prepare to create, sign, and serialize a SAML 2.0 Logout Request.
void	setClock(Clock clock)	Use this Clock for determining the issued Instant
void	setParametersConsumer(Consumer<OpenSaml4LogoutRequestResolver.LogoutRequestParameters> parametersConsumer)	Set a Consumer for modifying the OpenSAML LogoutRequest
void	setRelayStateResolver(org.springframework.core.convert.converter.Converter<jakarta.servlet.http.HttpServletRequest,String> relayStateResolver)	Use this Converter to compute the RelayState

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSaml4LogoutRequestResolver

public OpenSaml4LogoutRequestResolver(RelyingPartyRegistrationRepository registrations)

OpenSaml4LogoutRequestResolver

public OpenSaml4LogoutRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)

Construct a OpenSaml4LogoutRequestResolver

Method Details

resolve

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

Prepare to create, sign, and serialize a SAML 2.0 Logout Request. By default, includes a NameID based on the Authentication instance.

Specified by:

resolve in interface Saml2LogoutRequestResolver

Parameters:

request - the HTTP request

authentication - the current user

Returns:

a signed and serialized SAML 2.0 Logout Request

setParametersConsumer

public void setParametersConsumer(Consumer<OpenSaml4LogoutRequestResolver.LogoutRequestParameters> parametersConsumer)

Set a Consumer for modifying the OpenSAML LogoutRequest

Parameters:

parametersConsumer - a consumer that accepts an OpenSaml4LogoutRequestResolver.LogoutRequestParameters

setClock

public void setClock(Clock clock)

Use this Clock for determining the issued Instant

Parameters:

clock - the Clock to use

setRelayStateResolver

public void setRelayStateResolver(org.springframework.core.convert.converter.Converter<jakarta.servlet.http.HttpServletRequest,String> relayStateResolver)

Use this Converter to compute the RelayState

Parameters:

relayStateResolver - the Converter to use

Since:

6.1