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

Class OpenSaml4AuthenticationRequestResolver

java.lang.Object

org.springframework.security.saml2.provider.service.web.authentication.OpenSaml4AuthenticationRequestResolver

All Implemented Interfaces:

Saml2AuthenticationRequestResolver

public final class OpenSaml4AuthenticationRequestResolver
extends Object
implements Saml2AuthenticationRequestResolver

A strategy for resolving a SAML 2.0 Authentication Request from the HttpServletRequest using OpenSAML.

Since:

5.7

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSaml4AuthenticationRequestResolver.AuthnRequestContext

Field Summary

Fields inherited from interface org.springframework.security.saml2.provider.service.web.authentication.Saml2AuthenticationRequestResolver

DEFAULT_AUTHENTICATION_REQUEST_URI

Constructor Summary

Constructors

Constructor	Description
OpenSaml4AuthenticationRequestResolver(RelyingPartyRegistrationRepository registrations)	Construct an OpenSaml4AuthenticationRequestResolver
OpenSaml4AuthenticationRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)	Construct a OpenSaml4AuthenticationRequestResolver

Method Summary

Modifier and Type	Method	Description
<T extends AbstractSaml2AuthenticationRequest> T	resolve(jakarta.servlet.http.HttpServletRequest request)
void	setAuthnRequestCustomizer(Consumer<OpenSaml4AuthenticationRequestResolver.AuthnRequestContext> contextConsumer)	Set a Consumer for modifying the OpenSAML AuthnRequest
void	setClock(Clock clock)	Use this Clock for generating the issued Instant
void	setRelayStateResolver(org.springframework.core.convert.converter.Converter<jakarta.servlet.http.HttpServletRequest,String> relayStateResolver)	Use this Converter to compute the RelayState
void	setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher requestMatcher)	Set the RequestMatcher to use for setting the OpenSamlAuthenticationRequestResolver.setRequestMatcher(RequestMatcher) (RequestMatcher)}

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSaml4AuthenticationRequestResolver

public OpenSaml4AuthenticationRequestResolver(RelyingPartyRegistrationRepository registrations)

Construct an OpenSaml4AuthenticationRequestResolver

Parameters:

registrations - a repository for relying and asserting party configuration

Since:

6.1

OpenSaml4AuthenticationRequestResolver

public OpenSaml4AuthenticationRequestResolver(RelyingPartyRegistrationResolver relyingPartyRegistrationResolver)

Construct a OpenSaml4AuthenticationRequestResolver

Method Details

resolve

public <T extends AbstractSaml2AuthenticationRequest>
T resolve(jakarta.servlet.http.HttpServletRequest request)

Specified by:

resolve in interface Saml2AuthenticationRequestResolver

setAuthnRequestCustomizer

public void setAuthnRequestCustomizer(Consumer<OpenSaml4AuthenticationRequestResolver.AuthnRequestContext> contextConsumer)

Set a Consumer for modifying the OpenSAML AuthnRequest

Parameters:

contextConsumer - a consumer that accepts an OpenSaml4AuthenticationRequestResolver.AuthnRequestContext

setRequestMatcher

public void setRequestMatcher(org.springframework.security.web.util.matcher.RequestMatcher requestMatcher)

Set the RequestMatcher to use for setting the OpenSamlAuthenticationRequestResolver.setRequestMatcher(RequestMatcher) (RequestMatcher)}

Parameters:

requestMatcher - the RequestMatcher to identify authentication requests.

Since:

5.8

setClock

public void setClock(Clock clock)

Use this Clock for generating 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:

5.8