Class OpenSaml5AssertingPartyMetadataRepository

java.lang.Object

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

All Implemented Interfaces:

Iterable<AssertingPartyMetadata>, AssertingPartyMetadataRepository

@NullMarked
public final class OpenSaml5AssertingPartyMetadataRepository
extends Object
implements AssertingPartyMetadataRepository

An implementation of AssertingPartyMetadataRepository that uses a MetadataResolver to retrieve AssertingPartyMetadata instances.

The MetadataResolver constructed in withTrustedMetadataLocation(String) provides expiry-aware refreshing.

Since:

6.4

See Also:

• AssertingPartyMetadataRepository
• RelyingPartyRegistrations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder	A builder class for configuring OpenSaml5AssertingPartyMetadataRepository for a specific metadata location.

Constructor Summary

Constructors

Constructor	Description
OpenSaml5AssertingPartyMetadataRepository(org.opensaml.saml.metadata.resolver.MetadataResolver metadataResolver)	Construct an OpenSaml5AssertingPartyMetadataRepository using the provided MetadataResolver.

Method Summary

Modifier and Type	Method	Description
@Nullable AssertingPartyMetadata	findByEntityId(String entityId)	Retrieve an AssertingPartyMetadata by its EntityID.
Iterator<AssertingPartyMetadata>	iterator()
static OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder	withMetadataLocation(String metadataLocation)	Use this metadataLocation to retrieve refreshable, expiry-aware SAML 2.0 Asserting Party (IDP) metadata.
static OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder	withTrustedMetadataLocation(String metadataLocation)	Use this trusted metadataLocation to retrieve refreshable, expiry-aware SAML 2.0 Asserting Party (IDP) metadata.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

OpenSaml5AssertingPartyMetadataRepository

public OpenSaml5AssertingPartyMetadataRepository(org.opensaml.saml.metadata.resolver.MetadataResolver metadataResolver)

Construct an OpenSaml5AssertingPartyMetadataRepository using the provided MetadataResolver.

The MetadataResolver should either be of type IterableMetadataSource or it should have a RoleMetadataIndex configured.

Parameters:

metadataResolver - the MetadataResolver to use

Method Details

iterator

public Iterator<AssertingPartyMetadata> iterator()

Specified by:

iterator in interface Iterable<AssertingPartyMetadata>

findByEntityId

public @Nullable AssertingPartyMetadata findByEntityId(String entityId)

Retrieve an AssertingPartyMetadata by its EntityID.

Specified by:

findByEntityId in interface AssertingPartyMetadataRepository

Parameters:

entityId - the EntityID to lookup

Returns:

the found AssertingPartyMetadata, or null otherwise

withTrustedMetadataLocation

public static OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder withTrustedMetadataLocation(String metadataLocation)

Use this trusted metadataLocation to retrieve refreshable, expiry-aware SAML 2.0 Asserting Party (IDP) metadata.

Valid locations can be classpath- or file-based or they can be HTTPS endpoints. Some valid endpoints might include:

  metadataLocation = "classpath:asserting-party-metadata.xml";
  metadataLocation = "file:asserting-party-metadata.xml";
  metadataLocation = "https://ap.example.org/metadata";

Resolution of location is attempted immediately. To defer, wrap in CachingRelyingPartyRegistrationRepository.

Parameters:

metadataLocation - the classpath- or file-based locations or HTTPS endpoints of the asserting party metadata file

Returns:

the OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder for further configuration

withMetadataLocation

public static OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder withMetadataLocation(String metadataLocation)

Use this metadataLocation to retrieve refreshable, expiry-aware SAML 2.0 Asserting Party (IDP) metadata. Verification credentials are required.

Valid locations can be classpath- or file-based or they can be remote endpoints. Some valid endpoints might include:

  metadataLocation = "classpath:asserting-party-metadata.xml";
  metadataLocation = "file:asserting-party-metadata.xml";
  metadataLocation = "https://ap.example.org/metadata";

Resolution of location is attempted immediately. To defer, wrap in CachingRelyingPartyRegistrationRepository.

Parameters:

metadataLocation - the classpath- or file-based locations or remote endpoints of the asserting party metadata file

Returns:

the OpenSaml5AssertingPartyMetadataRepository.MetadataLocationRepositoryBuilder for further configuration