Class Saml2PostAuthenticationRequest
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.authentication.Saml2PostAuthenticationRequest
-
public class Saml2PostAuthenticationRequest extends java.lang.Object
Data holder for information required to send anAuthNRequest
over a POST 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Saml2PostAuthenticationRequest.Builder
Builder class for aSaml2PostAuthenticationRequest
object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAuthenticationRequestUri()
Returns the URI endpoint that this AuthNRequest should be sent to.Saml2MessageBinding
getBinding()
Returns the binding this AuthNRequest will be sent and encoded with.java.lang.String
getRelayState()
Returns the RelayState value, if present in the parametersjava.lang.String
getSamlRequest()
Returns the AuthNRequest XML value to be sent.static Saml2PostAuthenticationRequest.Builder
withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)
Constructs aSaml2PostAuthenticationRequest.Builder
from aSaml2AuthenticationRequestContext
object.
-
-
-
Method Detail
-
getBinding
public Saml2MessageBinding getBinding()
Returns the binding this AuthNRequest will be sent and encoded with. IfSaml2MessageBinding.REDIRECT
is used, the DEFLATE encoding will be automatically applied.- Returns:
Saml2MessageBinding.POST
-
withAuthenticationRequestContext
public static Saml2PostAuthenticationRequest.Builder withAuthenticationRequestContext(Saml2AuthenticationRequestContext context)
Constructs aSaml2PostAuthenticationRequest.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
-
getSamlRequest
public java.lang.String getSamlRequest()
Returns the AuthNRequest XML value to be sent. This value is already encoded for transport. IfgetBinding()
isSaml2MessageBinding.REDIRECT
the value is deflated and SAML encoded. IfgetBinding()
isSaml2MessageBinding.POST
the value is SAML encoded.- Returns:
- the SAMLRequest parameter value
-
getRelayState
public java.lang.String getRelayState()
Returns the RelayState value, if present in the parameters- Returns:
- the RelayState value, or null if not available
-
getAuthenticationRequestUri
public java.lang.String getAuthenticationRequestUri()
Returns the URI endpoint that this AuthNRequest should be sent to.- Returns:
- the URI endpoint for this message
-
-