org.opensaml.saml.metadata.resolver

Class ChainingMetadataResolver

java.lang.Object

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

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

org.opensaml.saml.metadata.resolver.ChainingMetadataResolver

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>, MetadataResolver, RefreshableMetadataResolver

public class ChainingMetadataResolver
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements MetadataResolver, RefreshableMetadataResolver

A metadata provider that uses registered resolvers, in turn, to answer queries. The Iterable of entity descriptors returned is the first non-null and non-empty Iterable found while iterating over the registered resolvers in resolver list order.

Constructor Summary

Constructors

Constructor and Description
ChainingMetadataResolver() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
org.joda.time.DateTime	getLastRefresh() Gets the time the last refresh cycle occurred.
org.joda.time.DateTime	getLastUpdate() Get the time that the currently available metadata was last updated.
MetadataFilter	getMetadataFilter() Gets the metadata filter applied to the metadata.
List<MetadataResolver>	getResolvers() Get an immutable the list of currently registered resolvers.
boolean	isRequireValidMetadata() Gets whether the metadata returned by queries must be valid.
void	refresh() Refresh the data exposed by the resolver.
Iterable<EntityDescriptor>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
EntityDescriptor	resolveSingle(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
void	setMetadataFilter(MetadataFilter newFilter) Sets the metadata filter applied to the metadata.
void	setRequireValidMetadata(boolean requireValidMetadata) Sets whether the metadata returned by queries must be valid.
void	setResolvers(List<? extends MetadataResolver> newResolvers) Set the registered metadata resolvers.

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

setId

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

getId

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.IdentifiedComponent

getId

Constructor Detail

ChainingMetadataResolver

public ChainingMetadataResolver()

Constructor.

Method Detail

getResolvers

@Nonnull
 @NonnullElements
 @Unmodifiable
 @NotLive
public List<MetadataResolver> getResolvers()

Get an immutable the list of currently registered resolvers.

Returns:

list of currently registered resolvers

setResolvers

public void setResolvers(@Nonnull @NonnullElements
                         List<? extends MetadataResolver> newResolvers)
                  throws net.shibboleth.utilities.java.support.resolver.ResolverException

Set the registered metadata resolvers.

Parameters:

newResolvers - the metadata resolvers to use

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem adding the metadata resolvers

isRequireValidMetadata

public boolean isRequireValidMetadata()

Gets whether the metadata returned by queries must be valid.

At a minimum, metadata is valid only if the date expressed in the validUntil attribute of the element and all its ancestral elements has not passed. Specific implementations may add additional constraints.

Specified by:

isRequireValidMetadata in interface MetadataResolver

Returns:

whether the metadata returned by queries must be valid

setRequireValidMetadata

public void setRequireValidMetadata(boolean requireValidMetadata)

Sets whether the metadata returned by queries must be valid.

Specified by:

setRequireValidMetadata in interface MetadataResolver

Parameters:

requireValidMetadata - whether the metadata returned by queries must be valid

getMetadataFilter

public MetadataFilter getMetadataFilter()

Gets the metadata filter applied to the metadata.

Specified by:

getMetadataFilter in interface MetadataResolver

Returns:

the metadata filter applied to the metadata

setMetadataFilter

public void setMetadataFilter(MetadataFilter newFilter)

Sets the metadata filter applied to the metadata.

Specified by:

setMetadataFilter in interface MetadataResolver

Parameters:

newFilter - the metadata filter applied to the metadata

resolveSingle

@Nullable
public EntityDescriptor resolveSingle(@Nullable
                                                net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                         throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolveSingle in interface net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

resolve

@Nonnull
public Iterable<EntityDescriptor> resolve(@Nullable
                                                   net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                            throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

resolve in interface net.shibboleth.utilities.java.support.resolver.Resolver<EntityDescriptor,net.shibboleth.utilities.java.support.resolver.CriteriaSet>

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException

refresh

public void refresh()
             throws net.shibboleth.utilities.java.support.resolver.ResolverException

Refresh the data exposed by the resolver.

An implementation of this method should typically be either synchronized or make use other locking mechanisms to protect against concurrent access.

Specified by:

refresh in interface RefreshableMetadataResolver

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if the refresh operation was unsuccessful

getLastUpdate

@Nullable
public org.joda.time.DateTime getLastUpdate()

Get the time that the currently available metadata was last updated. Note, this may be different than the time retrieved by RefreshableMetadataResolver.getLastRefresh() is the metadata was known not to have changed during the last refresh cycle.

Specified by:

getLastUpdate in interface RefreshableMetadataResolver

Returns:

time when the currently metadata was last updated, null if metadata has never successfully been read in

getLastRefresh

@Nullable
public org.joda.time.DateTime getLastRefresh()

Gets the time the last refresh cycle occurred.

Specified by:

getLastRefresh in interface RefreshableMetadataResolver

Returns:

time the last refresh cycle occurred

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent