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

Class RelyingPartyRegistration.AssertingPartyDetails

java.lang.Object

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

All Implemented Interfaces:

Serializable, AssertingPartyMetadata

Direct Known Subclasses:

OpenSamlAssertingPartyDetails

Enclosing class:

RelyingPartyRegistration

public static class RelyingPartyRegistration.AssertingPartyDetails
extends Object
implements AssertingPartyMetadata

The configuration metadata of the Asserting party

Since:

5.4

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RelyingPartyRegistration.AssertingPartyDetails.Builder

Method Summary

Modifier and Type	Method	Description
Collection<Saml2X509Credential>	getEncryptionX509Credentials()	Get all encryption Saml2X509Credentials associated with this asserting party
String	getEntityId()	Get the asserting party's EntityID.
List<String>	getSigningAlgorithms()	Get the list of org.opensaml.saml.ext.saml2alg.SigningMethod Algorithms for this asserting party, in preference order.
Saml2MessageBinding	getSingleLogoutServiceBinding()	Get the SingleLogoutService Binding
String	getSingleLogoutServiceLocation()	Get the SingleLogoutService Location
String	getSingleLogoutServiceResponseLocation()	Get the SingleLogoutService Response Location
Saml2MessageBinding	getSingleSignOnServiceBinding()	Get the SingleSignOnService Binding.
String	getSingleSignOnServiceLocation()	Get the SingleSignOnService Location.
Collection<Saml2X509Credential>	getVerificationX509Credentials()	Get all verification Saml2X509Credentials associated with this asserting party
boolean	getWantAuthnRequestsSigned()	Get the WantAuthnRequestsSigned setting, indicating the asserting party's preference that relying parties should sign the AuthnRequest before sending.
RelyingPartyRegistration.AssertingPartyDetails.Builder	mutate()

Methods inherited from class java.lang.Object

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

Method Details

getEntityId

public String getEntityId()

Get the asserting party's EntityID.

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

This value may contain a number of placeholders, which need to be resolved before use. They are baseUrl, registrationId, baseScheme, baseHost, and basePort.

Specified by:

getEntityId in interface AssertingPartyMetadata

Returns:

the asserting party's EntityID

getWantAuthnRequestsSigned

public boolean getWantAuthnRequestsSigned()

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

Specified by:

getWantAuthnRequestsSigned in interface AssertingPartyMetadata

Returns:

the WantAuthnRequestsSigned value

getSigningAlgorithms

public List<String> getSigningAlgorithms()

Get the list of org.opensaml.saml.ext.saml2alg.SigningMethod Algorithms for this asserting party, in preference order.

Equivalent to the values found in <SigningMethod Algorithm="..."/> in the asserting party's <IDPSSODescriptor>.

Specified by:

getSigningAlgorithms in interface AssertingPartyMetadata

Returns:

the list of SigningMethod Algorithms

Since:

5.5

getVerificationX509Credentials

public Collection<Saml2X509Credential> getVerificationX509Credentials()

Get all verification Saml2X509Credentials associated with this asserting party

Specified by:

getVerificationX509Credentials in interface AssertingPartyMetadata

Returns:

all verification Saml2X509Credentials associated with this asserting party

Since:

5.4

getEncryptionX509Credentials

public Collection<Saml2X509Credential> getEncryptionX509Credentials()

Get all encryption Saml2X509Credentials associated with this asserting party

Specified by:

getEncryptionX509Credentials in interface AssertingPartyMetadata

Returns:

all encryption Saml2X509Credentials associated with this asserting party

Since:

5.4

getSingleSignOnServiceLocation

public String getSingleSignOnServiceLocation()

Get the SingleSignOnService Location.

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

Specified by:

getSingleSignOnServiceLocation in interface AssertingPartyMetadata

Returns:

the SingleSignOnService Location

getSingleSignOnServiceBinding

public Saml2MessageBinding getSingleSignOnServiceBinding()

Get the SingleSignOnService Binding.

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

Specified by:

getSingleSignOnServiceBinding in interface AssertingPartyMetadata

Returns:

the SingleSignOnService Location

getSingleLogoutServiceLocation

public String getSingleLogoutServiceLocation()

Get the SingleLogoutService Location

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

Specified by:

getSingleLogoutServiceLocation in interface AssertingPartyMetadata

Returns:

the SingleLogoutService Location

Since:

5.6

getSingleLogoutServiceResponseLocation

public String getSingleLogoutServiceResponseLocation()

Get the SingleLogoutService Response Location

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

Specified by:

getSingleLogoutServiceResponseLocation in interface AssertingPartyMetadata

Returns:

the SingleLogoutService Response Location

Since:

5.6

getSingleLogoutServiceBinding

public Saml2MessageBinding getSingleLogoutServiceBinding()

Get the SingleLogoutService Binding

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

Specified by:

getSingleLogoutServiceBinding in interface AssertingPartyMetadata

Returns:

the SingleLogoutService Binding

Since:

5.6

mutate

public RelyingPartyRegistration.AssertingPartyDetails.Builder mutate()

Specified by:

mutate in interface AssertingPartyMetadata