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

Class Saml2AuthenticationRequestContext

java.lang.Object

org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext

public class Saml2AuthenticationRequestContext
extends java.lang.Object

Data holder for information required to create an AuthNRequest to be sent from the service provider to the identity provider Assertions and Protocols for SAML 2 (line 2031)

Since:

5.3

See Also:

Saml2AuthenticationRequestFactory.createPostAuthenticationRequest(Saml2AuthenticationRequestContext), Saml2AuthenticationRequestFactory.createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Saml2AuthenticationRequestContext.Builder	A builder for Saml2AuthenticationRequestContext.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Saml2AuthenticationRequestContext(RelyingPartyRegistration relyingPartyRegistration, java.lang.String issuer, java.lang.String assertionConsumerServiceUrl, java.lang.String relayState)

Method Summary

Modifier and Type	Method	Description
static Saml2AuthenticationRequestContext.Builder	builder()	A builder for Saml2AuthenticationRequestContext.
java.lang.String	getAssertionConsumerServiceUrl()	Returns the desired AssertionConsumerServiceUrl that this SP wishes to receive the assertion on.
java.lang.String	getDestination()	Returns the Destination, the WEB Single Sign On URI, for this authentication request.
java.lang.String	getIssuer()	Returns the Issuer value to be used in the AuthNRequest object.
java.lang.String	getRelayState()	Returns the RelayState value, if present in the parameters
RelyingPartyRegistration	getRelyingPartyRegistration()	Returns the RelyingPartyRegistration configuration for which the AuthNRequest is intended for.

Methods inherited from class java.lang.Object

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

Constructor Detail

Saml2AuthenticationRequestContext

protected Saml2AuthenticationRequestContext(RelyingPartyRegistration relyingPartyRegistration,
                                            java.lang.String issuer,
                                            java.lang.String assertionConsumerServiceUrl,
                                            java.lang.String relayState)

Method Detail

getRelyingPartyRegistration

public RelyingPartyRegistration getRelyingPartyRegistration()

Returns the RelyingPartyRegistration configuration for which the AuthNRequest is intended for.

Returns:

the RelyingPartyRegistration configuration

getIssuer

public java.lang.String getIssuer()

Returns the Issuer value to be used in the AuthNRequest object. This property should be used to populate the AuthNRequest.Issuer XML element. This value typically is a URI, but can be an arbitrary string.

Returns:

the Issuer value

getAssertionConsumerServiceUrl

public java.lang.String getAssertionConsumerServiceUrl()

Returns the desired AssertionConsumerServiceUrl that this SP wishes to receive the assertion on. The IDP may or may not honor this request. This property populates the AuthNRequest.AssertionConsumerServiceURL XML attribute.

Returns:

the AssertionConsumerServiceURL 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

getDestination

public java.lang.String getDestination()

Returns the Destination, the WEB Single Sign On URI, for this authentication request. This property can also populate the AuthNRequest.Destination XML attribute.

Returns:

the Destination value

builder

public static Saml2AuthenticationRequestContext.Builder builder()

A builder for Saml2AuthenticationRequestContext.

Returns:

a builder object