Class Saml2RedirectAuthenticationRequest
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest
-
- org.springframework.security.saml2.provider.service.authentication.Saml2RedirectAuthenticationRequest
-
- All Implemented Interfaces:
java.io.Serializable
public final class Saml2RedirectAuthenticationRequest extends AbstractSaml2AuthenticationRequest
Data holder for information required to send anAuthNRequest
over a REDIRECT binding from the service provider to the identity provider https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf (line 2031)- Since:
- 5.3
- See Also:
Saml2AuthenticationRequestFactory
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Saml2RedirectAuthenticationRequest.Builder
Builder class for aSaml2RedirectAuthenticationRequest
object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Saml2MessageBinding
getBinding()
Returns the binding this AuthNRequest will be sent and encoded with.java.lang.String
getSigAlg()
Returns the SigAlg value forSaml2MessageBinding.REDIRECT
requestsjava.lang.String
getSignature()
Returns the Signature value forSaml2MessageBinding.REDIRECT
requestsstatic Saml2RedirectAuthenticationRequest.Builder
withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)
Constructs aSaml2RedirectAuthenticationRequest.Builder
from aSaml2AuthenticationRequestContext
object.static Saml2RedirectAuthenticationRequest.Builder
withRelyingPartyRegistration(RelyingPartyRegistration registration)
Constructs aSaml2PostAuthenticationRequest.Builder
from aRelyingPartyRegistration
object.-
Methods inherited from class org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest
getAuthenticationRequestUri, getRelayState, getRelyingPartyRegistrationId, getSamlRequest
-
-
-
-
Method Detail
-
getSigAlg
public java.lang.String getSigAlg()
Returns the SigAlg value forSaml2MessageBinding.REDIRECT
requests- Returns:
- the SigAlg value
-
getSignature
public java.lang.String getSignature()
Returns the Signature value forSaml2MessageBinding.REDIRECT
requests- Returns:
- the Signature value
-
getBinding
public Saml2MessageBinding getBinding()
Description copied from class:AbstractSaml2AuthenticationRequest
Returns the binding this AuthNRequest will be sent and encoded with. IfSaml2MessageBinding.REDIRECT
is used, the DEFLATE encoding will be automatically applied.- Specified by:
getBinding
in classAbstractSaml2AuthenticationRequest
- Returns:
Saml2MessageBinding.REDIRECT
-
withAuthenticationRequestContext
public static Saml2RedirectAuthenticationRequest.Builder withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)
Constructs aSaml2RedirectAuthenticationRequest.Builder
from aSaml2AuthenticationRequestContext
object. By default theAbstractSaml2AuthenticationRequest.getAuthenticationRequestUri()
will be set to theSaml2AuthenticationRequestContext.getDestination()
value.- Parameters:
context
- input providingDestination
,RelayState
, andIssuer
objects.- Returns:
- a modifiable builder object
-
withRelyingPartyRegistration
public static Saml2RedirectAuthenticationRequest.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration)
Constructs aSaml2PostAuthenticationRequest.Builder
from aRelyingPartyRegistration
object.- Parameters:
registration
- a relying party registration- Returns:
- a modifiable builder object
- Since:
- 5.7
-
-