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

Class OpenSamlAssertingPartyDetails.Builder

java.lang.Object

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

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

All Implemented Interfaces:

AssertingPartyMetadata.Builder<RelyingPartyRegistration.AssertingPartyDetails.Builder>

Enclosing class:

OpenSamlAssertingPartyDetails

public static final class OpenSamlAssertingPartyDetails.Builder
extends RelyingPartyRegistration.AssertingPartyDetails.Builder

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

Method Summary

Modifier and Type	Method	Description
OpenSamlAssertingPartyDetails	build()	Build an OpenSamlAssertingPartyDetails
OpenSamlAssertingPartyDetails.Builder	encryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the list of Saml2X509Credentials
OpenSamlAssertingPartyDetails.Builder	entityId(String entityId)	Set the asserting party's EntityID.
OpenSamlAssertingPartyDetails.Builder	signingAlgorithms(Consumer<List<String>> signingMethodAlgorithmsConsumer)	Apply this Consumer to the list of SigningMethod Algorithms
OpenSamlAssertingPartyDetails.Builder	singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)	Set the SingleLogoutService Binding
OpenSamlAssertingPartyDetails.Builder	singleLogoutServiceLocation(String singleLogoutServiceLocation)	Set the SingleLogoutService Location
OpenSamlAssertingPartyDetails.Builder	singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation)	Set the SingleLogoutService Response Location
OpenSamlAssertingPartyDetails.Builder	singleSignOnServiceBinding(Saml2MessageBinding singleSignOnServiceBinding)	Set the SingleSignOnService Binding.
OpenSamlAssertingPartyDetails.Builder	singleSignOnServiceLocation(String singleSignOnServiceLocation)	Set the SingleSignOnService Location.
OpenSamlAssertingPartyDetails.Builder	verificationX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer)	Apply this Consumer to the list of Saml2X509Credentials
OpenSamlAssertingPartyDetails.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

Method Details

entityId

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

Overrides:

entityId in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

entityId - the asserting party's EntityID

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

wantAuthnRequestsSigned

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

Overrides:

wantAuthnRequestsSigned in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

wantAuthnRequestsSigned - the WantAuthnRequestsSigned setting

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

signingAlgorithms

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

Overrides:

signingAlgorithms in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

signingMethodAlgorithmsConsumer - a Consumer of the list of SigningMethod Algorithms

Returns:

this RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

verificationX509Credentials

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

Apply this Consumer to the list of Saml2X509Credentials

Specified by:

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

Overrides:

verificationX509Credentials in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

credentialsConsumer - a Consumer of the List of Saml2X509Credentials

Returns:

the RelyingPartyRegistration.Builder for further configuration

encryptionX509Credentials

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

Apply this Consumer to the list of Saml2X509Credentials

Specified by:

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

Overrides:

encryptionX509Credentials in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

credentialsConsumer - a Consumer of the List of Saml2X509Credentials

Returns:

the RelyingPartyRegistration.Builder for further configuration

singleSignOnServiceLocation

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

Overrides:

singleSignOnServiceLocation in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

singleSignOnServiceLocation - the SingleSignOnService Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleSignOnServiceBinding

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

Overrides:

singleSignOnServiceBinding in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

singleSignOnServiceBinding - the SingleSignOnService Binding

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleLogoutServiceLocation

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

Overrides:

singleLogoutServiceLocation in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

singleLogoutServiceLocation - the SingleLogoutService Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleLogoutServiceResponseLocation

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

Overrides:

singleLogoutServiceResponseLocation in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

singleLogoutServiceResponseLocation - the SingleLogoutService Response Location

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

singleLogoutServiceBinding

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

Overrides:

singleLogoutServiceBinding in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Parameters:

singleLogoutServiceBinding - the SingleLogoutService Binding

Returns:

the RelyingPartyRegistration.AssertingPartyDetails.Builder for further configuration

build

public OpenSamlAssertingPartyDetails build()

Build an OpenSamlAssertingPartyDetails

Specified by:

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

Overrides:

build in class RelyingPartyRegistration.AssertingPartyDetails.Builder

Returns: