Class AbstractSaml2AuthenticationRequest.Builder<T extends AbstractSaml2AuthenticationRequest.Builder<T>>

java.lang.Object

org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest.Builder<T>

Direct Known Subclasses:

Saml2PostAuthenticationRequest.Builder, Saml2RedirectAuthenticationRequest.Builder

Enclosing class:

AbstractSaml2AuthenticationRequest

public static class AbstractSaml2AuthenticationRequest.Builder<T extends AbstractSaml2AuthenticationRequest.Builder<T>>
extends Object

A builder for AbstractSaml2AuthenticationRequest and its subclasses.

Since:

5.3

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Deprecated. Use Builder(RelyingPartyRegistration) instead
protected	Builder(RelyingPartyRegistration registration)	Creates a new Builder with relying party registration

Method Summary

Modifier and Type	Method	Description
protected final T	_this()	Casting the return as the generic subtype, when returning itself
T	authenticationRequestUri(String authenticationRequestUri)	Sets the authenticationRequestUri, a URL that will receive the AuthNRequest message
T	id(String id)	This is the unique id used in the samlRequest
T	relayState(@Nullable String relayState)	Sets the RelayState parameter that will accompany this AuthNRequest
T	samlRequest(String samlRequest)	Sets the SAMLRequest parameter that will accompany this AuthNRequest

Methods inherited from class Object

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

Constructor Details

Builder

@Deprecated
protected Builder()

Deprecated.

Use Builder(RelyingPartyRegistration) instead

Builder

protected Builder(RelyingPartyRegistration registration)

Creates a new Builder with relying party registration

Parameters:

registration - the registration of the relying party.

Since:

5.8

Method Details

_this

protected final T _this()

Casting the return as the generic subtype, when returning itself

Returns:

this object

relayState

public T relayState(@Nullable String relayState)

Sets the RelayState parameter that will accompany this AuthNRequest

Parameters:

relayState - the relay state value, unencoded. if null or empty, the parameter will be removed from the map.

Returns:

this object

samlRequest

public T samlRequest(String samlRequest)

Sets the SAMLRequest parameter that will accompany this AuthNRequest

Parameters:

samlRequest - the SAMLRequest parameter.

Returns:

this object

authenticationRequestUri

public T authenticationRequestUri(String authenticationRequestUri)

Sets the authenticationRequestUri, a URL that will receive the AuthNRequest message

Parameters:

authenticationRequestUri - the relay state value, unencoded.

Returns:

this object

id

public T id(String id)

This is the unique id used in the samlRequest

Parameters:

id - the SAML2 request id

Returns:

the AbstractSaml2AuthenticationRequest.Builder for further configurations

Since:

5.8