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

Class Saml2AuthenticationRequestContext.Builder

java.lang.Object

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

Enclosing class:

Saml2AuthenticationRequestContext

public static final class Saml2AuthenticationRequestContext.Builder
extends Object

A builder for Saml2AuthenticationRequestContext.

Method Summary

Modifier and Type	Method	Description
Saml2AuthenticationRequestContext.Builder	assertionConsumerServiceUrl(String assertionConsumerServiceUrl)	Sets the assertionConsumerServiceURL for the authentication request.
Saml2AuthenticationRequestContext	build()	Creates a Saml2AuthenticationRequestContext object.
Saml2AuthenticationRequestContext.Builder	issuer(String issuer)	Sets the issuer for the authentication request.
Saml2AuthenticationRequestContext.Builder	relayState(String relayState)	Sets the RelayState parameter that will accompany this AuthNRequest
Saml2AuthenticationRequestContext.Builder	relyingPartyRegistration(RelyingPartyRegistration relyingPartyRegistration)	Sets the RelyingPartyRegistration used to build the authentication request.

Methods inherited from class java.lang.Object

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

Method Details

issuer

public Saml2AuthenticationRequestContext.Builder issuer(String issuer)

Sets the issuer for the authentication request.

Parameters:

issuer - - a required value

Returns:

this Builder

relyingPartyRegistration

public Saml2AuthenticationRequestContext.Builder relyingPartyRegistration(RelyingPartyRegistration relyingPartyRegistration)

Sets the RelyingPartyRegistration used to build the authentication request.

Parameters:

relyingPartyRegistration - - a required value

Returns:

this Builder

assertionConsumerServiceUrl

public Saml2AuthenticationRequestContext.Builder assertionConsumerServiceUrl(String assertionConsumerServiceUrl)

Sets the assertionConsumerServiceURL for the authentication request. Typically the Service Provider EntityID

Parameters:

assertionConsumerServiceUrl - - a required value

Returns:

this Builder

relayState

public Saml2AuthenticationRequestContext.Builder relayState(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

build

public Saml2AuthenticationRequestContext build()

Creates a Saml2AuthenticationRequestContext object.

Returns:

the Saml2AuthenticationRequest object

Throws:

IllegalArgumentException - if a required property is not set