se.litsec.opensaml.saml2.metadata.provider

Class CompositeMetadataProvider

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

se.litsec.opensaml.saml2.metadata.provider.CompositeMetadataProvider

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MetadataProvider

public class CompositeMetadataProvider
extends AbstractMetadataProvider

A metadata provider that collects its metadata from multiple sources (providers).

It is recommended that all providers installed have the failFastInitialization property set to false. Otherwise a failing provider will shut down the entire compostite provider.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

See Also:

CompositeMetadataResolver

Nested Class Summary

Nested classes/interfaces inherited from class se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

AbstractMetadataProvider.EntityDescriptorIterator

Constructor Summary

Constructors

Constructor and Description
CompositeMetadataProvider(String id, List<MetadataProvider> metadataProviders) Constructs a composite metadata provider by assigning it a list of provider instances that it shall read its metadata from.

Method Summary

Modifier and Type	Method and Description
protected MetadataFilter	createFilter() Returns null since the CompositeMetadataResolver doesn't perform any filtering.
protected void	createMetadataResolver(boolean requireValidMetadata, boolean failFastInitialization, MetadataFilter filter) Creates the specific MetadataResolver instance for the provider implementation.
protected void	destroyMetadataResolver() Destroys the metadata resolver.
String	getID() Returns the identifier for the provider.
Optional<org.joda.time.DateTime>	getLastUpdate() Returns the time the currently available metadata was last updated.
Optional<XMLObject>	getMetadata() Collects all metadata from all underlying providers and creates an EntitiesDescriptor element.
MetadataResolver	getMetadataResolver() Returns the underlying OpenSAML metadata resolver.
protected void	initializeMetadataResolver() Initializes the metadata resolver.
void	setExclusionPredicates(List<Predicate<EntityDescriptor>> exclusionPredicates) It is not possible to set configuration for metadata for a CompositeMetadataResolver.
void	setFailFastInitialization(boolean failFast) It is not possible to set configuration for metadata for a CompositeMetadataResolver.
void	setInclusionPredicates(List<Predicate<EntityDescriptor>> inclusionPredicates) It is not possible to set configuration for metadata for a CompositeMetadataResolver.
void	setPerformSchemaValidation(boolean performSchemaValidation) It is not possible to set configuration for metadata for a CompositeMetadataResolver.
void	setRequireValidMetadata(boolean requireValidMetadata) It is not possible to set configuration for metadata for a CompositeMetadataResolver.
void	setSignatureVerificationCertificate(X509Certificate signatureVerificationCertificate) It is not possible to set configuration for metadata for a CompositeMetadataResolver.

Methods inherited from class se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

doDestroy, doInitialize, getEntityDescriptor, getIdentityProviders, getIDPSSODescriptor, getMetadataDOM, getServiceProviders, getSPSSODescriptor, iterator, iterator, refresh

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Constructor Detail

CompositeMetadataProvider

public CompositeMetadataProvider(String id,
                                 List<MetadataProvider> metadataProviders)

Constructs a composite metadata provider by assigning it a list of provider instances that it shall read its metadata from.

The id parameter will also by used as the Name attribute for the EntitiesDescriptor that will be returned by getMetadata().

Parameters:

id - the identifier for the provider (may not be changed later on)

metadataProviders - a list of providers

Method Detail

getID

public String getID()

Returns the identifier for the provider.

Returns:

the identifier

getMetadataResolver

public MetadataResolver getMetadataResolver()

Returns the underlying OpenSAML metadata resolver.

Returns:

OpenSAML metadata resolver

getMetadata

public Optional<XMLObject> getMetadata()

Collects all metadata from all underlying providers and creates an EntitiesDescriptor element. Any duplicate entity ID:s will be removed.

Specified by:

getMetadata in interface MetadataProvider

Overrides:

getMetadata in class AbstractMetadataProvider

Returns:

an XML element

getLastUpdate

public Optional<org.joda.time.DateTime> getLastUpdate()

Returns the time the currently available metadata was last updated.

Specified by:

getLastUpdate in interface MetadataProvider

Overrides:

getLastUpdate in class AbstractMetadataProvider

Returns:

time when the currently metadata was last updated, or an empty optional if no metadata has been successfully loaded

createMetadataResolver

protected void createMetadataResolver(boolean requireValidMetadata,
                                      boolean failFastInitialization,
                                      MetadataFilter filter)
                               throws ResolverException

Creates the specific MetadataResolver instance for the provider implementation.

The filter parameter is a MetadataFilter that must be installed for the resolver. Any other filters that should be installed by the specific instance should be placed last in a filter chain.

Specified by:

createMetadataResolver in class AbstractMetadataProvider

Parameters:

requireValidMetadata - should be passed into MetadataResolver.setRequireValidMetadata(boolean)

failFastInitialization - should be passed into AbstractMetadataResolver.setFailFastInitialization(boolean) (if applicable)

filter - filter that must be installed for the resolver

Throws:

ResolverException - for errors creating the resolver

createFilter

protected MetadataFilter createFilter()

Returns null since the CompositeMetadataResolver doesn't perform any filtering.

Overrides:

createFilter in class AbstractMetadataProvider

Returns:

a metadata filter

initializeMetadataResolver

protected void initializeMetadataResolver()
                                   throws ComponentInitializationException

Initializes the metadata resolver.

Specified by:

initializeMetadataResolver in class AbstractMetadataProvider

Throws:

ComponentInitializationException - for initialization errors

destroyMetadataResolver

protected void destroyMetadataResolver()

Destroys the metadata resolver.

Specified by:

destroyMetadataResolver in class AbstractMetadataProvider

setRequireValidMetadata

public void setRequireValidMetadata(boolean requireValidMetadata)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setRequireValidMetadata in class AbstractMetadataProvider

Parameters:

requireValidMetadata - whether the metadata returned by queries must be valid

setFailFastInitialization

public void setFailFastInitialization(boolean failFast)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setFailFastInitialization in class AbstractMetadataProvider

Parameters:

failFast - whether problems during initialization should cause the provider to fail

setInclusionPredicates

public void setInclusionPredicates(List<Predicate<EntityDescriptor>> inclusionPredicates)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setInclusionPredicates in class AbstractMetadataProvider

Parameters:

inclusionPredicates - predicates

See Also:

MetadataProviderPredicates

setExclusionPredicates

public void setExclusionPredicates(List<Predicate<EntityDescriptor>> exclusionPredicates)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setExclusionPredicates in class AbstractMetadataProvider

Parameters:

exclusionPredicates - predicates

See Also:

MetadataProviderPredicates

setSignatureVerificationCertificate

public void setSignatureVerificationCertificate(X509Certificate signatureVerificationCertificate)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setSignatureVerificationCertificate in class AbstractMetadataProvider

Parameters:

signatureVerificationCertificate - the certificate to assign

setPerformSchemaValidation

public void setPerformSchemaValidation(boolean performSchemaValidation)

It is not possible to set configuration for metadata for a CompositeMetadataResolver. This should be done on each of the underlying resolvers.

Overrides:

setPerformSchemaValidation in class AbstractMetadataProvider

Parameters:

performSchemaValidation - whether schema validation should be performed