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.-
Constructor Summary
ModifierConstructorDescriptionprotected
Builder()
Deprecated.protected
Builder
(RelyingPartyRegistration registration) Creates a new Builder with relying party registration -
Method Summary
Modifier and TypeMethodDescriptionprotected final T
_this()
Casting the return as the generic subtype, when returning itselfauthenticationRequestUri
(String authenticationRequestUri) Sets theauthenticationRequestUri
, a URL that will receive the AuthNRequest messageThis is the unique id used in thesamlRequest
relayState
(String relayState) Sets theRelayState
parameter that will accompany this AuthNRequestsamlRequest
(String samlRequest) Sets theSAMLRequest
parameter that will accompany this AuthNRequest
-
Constructor Details
-
Builder
Deprecated.UseBuilder(RelyingPartyRegistration)
instead -
Builder
Creates a new Builder with relying party registration- Parameters:
registration
- the registration of the relying party.
-
-
Method Details
-
_this
Casting the return as the generic subtype, when returning itself- Returns:
- this object
-
relayState
Sets theRelayState
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
Sets theSAMLRequest
parameter that will accompany this AuthNRequest- Parameters:
samlRequest
- the SAMLRequest parameter.- Returns:
- this object
-
authenticationRequestUri
Sets theauthenticationRequestUri
, a URL that will receive the AuthNRequest message- Parameters:
authenticationRequestUri
- the relay state value, unencoded.- Returns:
- this object
-
id
This is the unique id used in thesamlRequest
- Parameters:
id
- the SAML2 request id- Returns:
- the
AbstractSaml2AuthenticationRequest.Builder
for further configurations - Since:
- 5.8
-
Builder(RelyingPartyRegistration)
instead