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

Class RelyingPartyRegistration.AssertingPartyDetails.Builder

java.lang.Object

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

All Implemented Interfaces:

AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Direct Known Subclasses:

OpenSamlAssertingPartyDetails.Builder

Enclosing class:

RelyingPartyRegistration.AssertingPartyDetails

public static class RelyingPartyRegistration.AssertingPartyDetails.Builder
extends Object
implements AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RelyingPartyRegistration.AssertingPartyDetails	build()	Creates an immutable ProviderDetails object representing the configuration for an Identity Provider, IDP
RelyingPartyRegistration.AssertingPartyDetails.Builder	encryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the list of Saml2X509Credentials
RelyingPartyRegistration.AssertingPartyDetails.Builder	entityId(String entityId)	Set the asserting party's EntityID.
RelyingPartyRegistration.AssertingPartyDetails.Builder	signingAlgorithms(Consumer<List<String>> signingMethodAlgorithmsConsumer)	Apply this Consumer to the list of SigningMethod Algorithms
RelyingPartyRegistration.AssertingPartyDetails.Builder	singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)	Set the SingleLogoutService Binding
RelyingPartyRegistration.AssertingPartyDetails.Builder	singleLogoutServiceLocation(String singleLogoutServiceLocation)	Set the SingleLogoutService Location
RelyingPartyRegistration.AssertingPartyDetails.Builder	singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)	Set the SingleLogoutService Response Location
RelyingPartyRegistration.AssertingPartyDetails.Builder	singleSignOnServiceBinding(Saml2MessageBinding singleSignOnServiceBinding)	Set the SingleSignOnService Binding.
RelyingPartyRegistration.AssertingPartyDetails.Builder	singleSignOnServiceLocation(String singleSignOnServiceLocation)	Set the SingleSignOnService Location.
RelyingPartyRegistration.AssertingPartyDetails.Builder	verificationX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the list of Saml2X509Credentials
RelyingPartyRegistration.AssertingPartyDetails.Builder	wantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)	Set the WantAuthnRequestsSigned setting, indicating the asserting party's preference that relying parties should sign the AuthnRequest before sending.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

entityId

public RelyingPartyRegistration.AssertingPartyDetails.Builder entityId(String entityId)

Set the asserting party's EntityID. Equivalent to the value found in the asserting party's <EntityDescriptor EntityID="..."/>

Specified by:

entityId in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

entityId - the asserting party's EntityID

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

wantAuthnRequestsSigned

public RelyingPartyRegistration.AssertingPartyDetails.Builder wantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)

Set the WantAuthnRequestsSigned setting, indicating the asserting party's preference that relying parties should sign the AuthnRequest before sending.

Specified by:

wantAuthnRequestsSigned in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

wantAuthnRequestsSigned - the WantAuthnRequestsSigned setting

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

signingAlgorithms

public RelyingPartyRegistration.AssertingPartyDetails.Builder signingAlgorithms(Consumer<List<String>> signingMethodAlgorithmsConsumer)

Apply this Consumer to the list of SigningMethod Algorithms

Specified by:

signingAlgorithms in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

signingMethodAlgorithmsConsumer - a Consumer of the list of SigningMethod Algorithms

Returns:

this RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

Since:

5.5

verificationX509Credentials

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

Apply this Consumer to the list of Saml2X509Credentials

Specified by:

verificationX509Credentials in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

credentialsConsumer - a Consumer of the List of Saml2X509Credentials

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

encryptionX509Credentials

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

Apply this Consumer to the list of Saml2X509Credentials

Specified by:

encryptionX509Credentials in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

credentialsConsumer - a Consumer of the List of Saml2X509Credentials

Returns:

the RelyingPartyRegistration.Builder for further configuration

Since:

5.4

singleSignOnServiceLocation

public RelyingPartyRegistration.AssertingPartyDetails.Builder singleSignOnServiceLocation(String singleSignOnServiceLocation)

Set the SingleSignOnService Location.

Equivalent to the value found in <SingleSignOnService Location="..."/> in the asserting party's <IDPSSODescriptor>.

Specified by:

singleSignOnServiceLocation in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

singleSignOnServiceLocation - the SingleSignOnService Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleSignOnServiceBinding

public RelyingPartyRegistration.AssertingPartyDetails.Builder singleSignOnServiceBinding(Saml2MessageBinding singleSignOnServiceBinding)

Set the SingleSignOnService Binding.

Equivalent to the value found in <SingleSignOnService Binding="..."/> in the asserting party's <IDPSSODescriptor>.

Specified by:

singleSignOnServiceBinding in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

singleSignOnServiceBinding - the SingleSignOnService Binding

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleLogoutServiceLocation

public RelyingPartyRegistration.AssertingPartyDetails.Builder singleLogoutServiceLocation(String singleLogoutServiceLocation)

Set the SingleLogoutService Location

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

Specified by:

singleLogoutServiceLocation in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

singleLogoutServiceLocation - the SingleLogoutService Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

Since:

5.6

singleLogoutServiceResponseLocation

public RelyingPartyRegistration.AssertingPartyDetails.Builder singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)

Set the SingleLogoutService Response Location

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

Specified by:

singleLogoutServiceResponseLocation in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

singleLogoutServiceResponseLocation - the SingleLogoutService Response Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

Since:

5.6

singleLogoutServiceBinding

public RelyingPartyRegistration.AssertingPartyDetails.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)

Set the SingleLogoutService Binding

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

Specified by:

singleLogoutServiceBinding in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Parameters:

singleLogoutServiceBinding - the SingleLogoutService Binding

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

Since:

5.6

build

public RelyingPartyRegistration.AssertingPartyDetails build()

Creates an immutable ProviderDetails object representing the configuration for an Identity Provider, IDP

Specified by:

build in interface AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Returns:

immutable ProviderDetails object