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

Class RelyingPartyRegistration.Builder

java.lang.Object

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

Direct Known Subclasses:

OpenSamlRelyingPartyRegistration.Builder

Enclosing class:

RelyingPartyRegistration

public static class RelyingPartyRegistration.Builder
extends Object

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String registrationId, AssertingPartyMetadata.Builder<?> assertingPartyMetadataBuilder)

Method Summary

Modifier and Type	Method	Description
RelyingPartyRegistration.Builder	assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails)	Deprecated, for removal: This API element is subject to removal in a future version. Use assertingPartyMetadata(java.util.function.Consumer<org.springframework.security.saml2.provider.service.registration.AssertingPartyMetadata.Builder<?>>) instead
RelyingPartyRegistration.Builder	assertingPartyMetadata(Consumer<AssertingPartyMetadata.Builder<?>> assertingPartyMetadata)	Apply this Consumer to further configure the Asserting Party metadata
RelyingPartyRegistration.Builder	assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding)	Set the AssertionConsumerService Binding.
RelyingPartyRegistration.Builder	assertionConsumerServiceLocation(String assertionConsumerServiceLocation)	Set the AssertionConsumerService Location.
RelyingPartyRegistration.Builder	authnRequestsSigned(Boolean authnRequestsSigned)	Set the AuthnRequestsSigned setting.
RelyingPartyRegistration	build()	Constructs a RelyingPartyRegistration object based on the builder configurations
RelyingPartyRegistration.Builder	decryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection
RelyingPartyRegistration.Builder	entityId(String entityId)	Set the relying party's EntityID.
RelyingPartyRegistration.Builder	nameIdFormat(String nameIdFormat)	Set the NameID format
RelyingPartyRegistration.Builder	registrationId(String id)	Sets the registrationId template.
RelyingPartyRegistration.Builder	signingX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the Collection of Saml2X509Credentials for the purposes of modifying the Collection
RelyingPartyRegistration.Builder	singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)	Set the SingleLogoutService Binding
RelyingPartyRegistration.Builder	singleLogoutServiceBindings(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer)	Apply this Consumer to the Collection of Saml2MessageBindings for the purposes of modifying the SingleLogoutService Binding Collection.
RelyingPartyRegistration.Builder	singleLogoutServiceLocation(String singleLogoutServiceLocation)	Set the SingleLogoutService Location
RelyingPartyRegistration.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

Constructor Details

Builder

protected Builder(String registrationId,
 AssertingPartyMetadata.Builder<?> assertingPartyMetadataBuilder)

Method Details

registrationId

public RelyingPartyRegistration.Builder registrationId(String id)

Sets the registrationId template. Often be used in URL paths

Parameters:

id - registrationId for this object, should be unique

Returns:

this object

entityId

public RelyingPartyRegistration.Builder entityId(String entityId)

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.

Parameters:

entityId - the relying party's EntityID

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

signingX509Credentials

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

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

Parameters:

credentialsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

decryptionX509Credentials

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

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

Parameters:

credentialsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

assertionConsumerServiceLocation

public RelyingPartyRegistration.Builder assertionConsumerServiceLocation(String assertionConsumerServiceLocation)

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.

Parameters:

assertionConsumerServiceLocation - the AssertionConsumerService location

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

assertionConsumerServiceBinding

public RelyingPartyRegistration.Builder assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding)

Set the AssertionConsumerService Binding.

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

Parameters:

assertionConsumerServiceBinding - the AssertionConsumerService binding

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

singleLogoutServiceBinding

public RelyingPartyRegistration.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)

Set the SingleLogoutService Binding

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

Parameters:

singleLogoutServiceBinding - the SingleLogoutService Binding

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.6

singleLogoutServiceBindings

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

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>.

Parameters:

bindingsConsumer - - the Consumer for modifying the Collection

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.8

singleLogoutServiceLocation

public RelyingPartyRegistration.Builder singleLogoutServiceLocation(String singleLogoutServiceLocation)

Set the SingleLogoutService Location

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

Parameters:

singleLogoutServiceLocation - the SingleLogoutService Location

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.6

singleLogoutServiceResponseLocation

public RelyingPartyRegistration.Builder singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)

Set the SingleLogoutService Response Location

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

Parameters:

singleLogoutServiceResponseLocation - the SingleLogoutService Response Location

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.6

nameIdFormat

public RelyingPartyRegistration.Builder nameIdFormat(String nameIdFormat)

Set the NameID format

Parameters:

nameIdFormat -

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.7

authnRequestsSigned

public RelyingPartyRegistration.Builder authnRequestsSigned(Boolean authnRequestsSigned)

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.

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

6.1

assertingPartyDetails

@Deprecated(forRemoval=true,
            since="6.4")
public RelyingPartyRegistration.Builder assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails)

Deprecated, for removal: This API element is subject to removal in a future version.

Use assertingPartyMetadata(java.util.function.Consumer<org.springframework.security.saml2.provider.service.registration.AssertingPartyMetadata.Builder<?>>) instead

Apply this Consumer to further configure the Asserting Party details

Parameters:

assertingPartyDetails - The Consumer to apply

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

assertingPartyMetadata

public RelyingPartyRegistration.Builder assertingPartyMetadata(Consumer<AssertingPartyMetadata.Builder<?>> assertingPartyMetadata)

Apply this Consumer to further configure the Asserting Party metadata

Parameters:

assertingPartyMetadata - The Consumer to apply

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

6.4

build

public RelyingPartyRegistration build()

Constructs a RelyingPartyRegistration object based on the builder configurations

Returns:

a RelyingPartyRegistration instance