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

Class OpenSamlRelyingPartyRegistration.Builder

java.lang.Object

org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.Builder

org.springframework.security.saml2.provider.service.registration.OpenSamlRelyingPartyRegistration.Builder

Enclosing class:

OpenSamlRelyingPartyRegistration

public static final class OpenSamlRelyingPartyRegistration.Builder
extends RelyingPartyRegistration.Builder

An OpenSAML version of RelyingPartyRegistration.AssertingPartyDetails.Builder that contains the underlying EntityDescriptor

Method Summary

Modifier and Type	Method	Description
OpenSamlRelyingPartyRegistration.Builder	assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails)	Apply this Consumer to further configure the Asserting Party details
OpenSamlRelyingPartyRegistration.Builder	assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding)	Set the AssertionConsumerService Binding.
OpenSamlRelyingPartyRegistration.Builder	assertionConsumerServiceLocation(String assertionConsumerServiceLocation)	Set the AssertionConsumerService Location.
OpenSamlRelyingPartyRegistration.Builder	authnRequestsSigned(Boolean authnRequestsSigned)	Set the AuthnRequestsSigned setting.
OpenSamlRelyingPartyRegistration	build()	Build an OpenSamlRelyingPartyRegistration OpenSamlRelyingPartyRegistration
OpenSamlRelyingPartyRegistration.Builder	decryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection
OpenSamlRelyingPartyRegistration.Builder	entityId(String entityId)	Set the relying party's EntityID.
OpenSamlRelyingPartyRegistration.Builder	nameIdFormat(String nameIdFormat)	Set the NameID format
OpenSamlRelyingPartyRegistration.Builder	registrationId(String id)	Sets the registrationId template.
OpenSamlRelyingPartyRegistration.Builder	signingX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection
OpenSamlRelyingPartyRegistration.Builder	singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)	Set the SingleLogoutService Binding
OpenSamlRelyingPartyRegistration.Builder	singleLogoutServiceBindings(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer)	Apply this Consumer to the Collection of Saml2MessageBindings for the purposes of modifying the SingleLogoutService Binding Collection.
OpenSamlRelyingPartyRegistration.Builder	singleLogoutServiceLocation(String singleLogoutServiceLocation)	Set the SingleLogoutService Location
OpenSamlRelyingPartyRegistration.Builder	singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)	Set the SingleLogoutService Response Location

Methods inherited from class java.lang.Object

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

Method Details

registrationId

public OpenSamlRelyingPartyRegistration.Builder registrationId(String id)

Description copied from class: RelyingPartyRegistration.Builder

Sets the registrationId template. Often be used in URL paths

Overrides:

registrationId in class RelyingPartyRegistration.Builder

Parameters:

id - registrationId for this object, should be unique

Returns:

this object

entityId

public OpenSamlRelyingPartyRegistration.Builder entityId(String entityId)

Description copied from class: RelyingPartyRegistration.Builder

Set the relying party's EntityID. Equivalent to the value found in the relying party's <EntityDescriptor EntityID="..."/> This value may contain a number of placeholders. They are baseUrl, registrationId, baseScheme, baseHost, and basePort.

Overrides:

entityId in class RelyingPartyRegistration.Builder

Parameters:

entityId - the relying party's EntityID

Returns:

the RelyingPartyRegistration.Builder for further configuration

signingX509Credentials

public OpenSamlRelyingPartyRegistration.Builder signingX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)

Description copied from class: RelyingPartyRegistration.Builder

Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection

Overrides:

signingX509Credentials in class RelyingPartyRegistration.Builder

Parameters:

credentialsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

decryptionX509Credentials

public OpenSamlRelyingPartyRegistration.Builder decryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)

Description copied from class: RelyingPartyRegistration.Builder

Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection

Overrides:

decryptionX509Credentials in class RelyingPartyRegistration.Builder

Parameters:

credentialsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

assertionConsumerServiceLocation

public OpenSamlRelyingPartyRegistration.Builder assertionConsumerServiceLocation(String assertionConsumerServiceLocation)

Description copied from class: RelyingPartyRegistration.Builder

Set the AssertionConsumerService Location.

Equivalent to the value found in <AssertionConsumerService Location="..."/> in the relying party's <SPSSODescriptor>

This value may contain a number of placeholders. They are baseUrl, registrationId, baseScheme, baseHost, and basePort.

Overrides:

assertionConsumerServiceLocation in class RelyingPartyRegistration.Builder

Parameters:

assertionConsumerServiceLocation - the AssertionConsumerService location

Returns:

the RelyingPartyRegistration.Builder for further configuration

assertionConsumerServiceBinding

public OpenSamlRelyingPartyRegistration.Builder assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding)

Description copied from class: RelyingPartyRegistration.Builder

Set the AssertionConsumerService Binding.

Equivalent to the value found in <AssertionConsumerService Binding="..."/> in the relying party's <SPSSODescriptor>

Overrides:

assertionConsumerServiceBinding in class RelyingPartyRegistration.Builder

Parameters:

assertionConsumerServiceBinding - the AssertionConsumerService binding

Returns:

the RelyingPartyRegistration.Builder for further configuration

singleLogoutServiceBinding

public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)

Description copied from class: RelyingPartyRegistration.Builder

Set the SingleLogoutService Binding

Equivalent to the value found in <SingleLogoutService Binding="..."/> in the relying party's <SPSSODescriptor>.

Overrides:

singleLogoutServiceBinding in class RelyingPartyRegistration.Builder

Parameters:

singleLogoutServiceBinding - the SingleLogoutService Binding

Returns:

the RelyingPartyRegistration.Builder for further configuration

singleLogoutServiceBindings

public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceBindings(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer)

Description copied from class: RelyingPartyRegistration.Builder

Apply this Consumer to the Collection of Saml2MessageBindings for the purposes of modifying the SingleLogoutService Binding Collection.

Equivalent to the value found in <SingleLogoutService Binding="..."/> in the relying party's <SPSSODescriptor>.

Overrides:

singleLogoutServiceBindings in class RelyingPartyRegistration.Builder

Parameters:

bindingsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

singleLogoutServiceLocation

public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceLocation(String singleLogoutServiceLocation)

Description copied from class: RelyingPartyRegistration.Builder

Set the SingleLogoutService Location

Equivalent to the value found in <SingleLogoutService Location="..."/> in the relying party's <SPSSODescriptor>.

Overrides:

singleLogoutServiceLocation in class RelyingPartyRegistration.Builder

Parameters:

singleLogoutServiceLocation - the SingleLogoutService Location

Returns:

the RelyingPartyRegistration.Builder for further configuration

singleLogoutServiceResponseLocation

public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)

Description copied from class: RelyingPartyRegistration.Builder

Set the SingleLogoutService Response Location

Equivalent to the value found in <SingleLogoutService ResponseLocation="..."/> in the relying party's <SPSSODescriptor>.

Overrides:

singleLogoutServiceResponseLocation in class RelyingPartyRegistration.Builder

Parameters:

singleLogoutServiceResponseLocation - the SingleLogoutService Response Location

Returns:

the RelyingPartyRegistration.Builder for further configuration

nameIdFormat

public OpenSamlRelyingPartyRegistration.Builder nameIdFormat(String nameIdFormat)

Description copied from class: RelyingPartyRegistration.Builder

Set the NameID format

Overrides:

nameIdFormat in class RelyingPartyRegistration.Builder

Returns:

the RelyingPartyRegistration.Builder for further configuration

authnRequestsSigned

public OpenSamlRelyingPartyRegistration.Builder authnRequestsSigned(Boolean authnRequestsSigned)

Description copied from class: RelyingPartyRegistration.Builder

Set the AuthnRequestsSigned setting. If true, the relying party will sign all AuthnRequests, 301 asserting party preference.

Note that Spring Security will sign the request if either RelyingPartyRegistration.isAuthnRequestsSigned() is true or RelyingPartyRegistration.AssertingPartyDetails.getWantAuthnRequestsSigned() is true.

Overrides:

authnRequestsSigned in class RelyingPartyRegistration.Builder

Returns:

the RelyingPartyRegistration.Builder for further configuration

assertingPartyDetails

public OpenSamlRelyingPartyRegistration.Builder assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails)

Description copied from class: RelyingPartyRegistration.Builder

Apply this Consumer to further configure the Asserting Party details

Overrides:

assertingPartyDetails in class RelyingPartyRegistration.Builder

Parameters:

assertingPartyDetails - The Consumer to apply

Returns:

the RelyingPartyRegistration.Builder for further configuration

build

public OpenSamlRelyingPartyRegistration build()

Build an OpenSamlRelyingPartyRegistration OpenSamlRelyingPartyRegistration

Overrides:

build in class RelyingPartyRegistration.Builder

Returns:

an OpenSamlRelyingPartyRegistration