org.opensaml.saml.metadata.resolver.impl

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

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private List<MetadataResolver>	resolvers Registered resolvers.

Constructor Summary

Constructors

Constructor and Description
ChainingMetadataResolver() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
MetadataFilter	getMetadataFilter()
List<MetadataResolver>	getResolvers() Gets an immutable the list of currently registered resolvers.
boolean	isRequireValidMetadata()
void	refresh()
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)
void	setRequireValidMetadata(boolean requireValidMetadata)
void	setResolvers(List<MetadataResolver> newResolvers) Sets the current set of 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

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

Field Detail

log

private final Logger log

Class logger.

resolvers

private List<MetadataResolver> resolvers

Registered resolvers.

Constructor Detail

ChainingMetadataResolver

public ChainingMetadataResolver()

Constructor.

Method Detail

getResolvers

public List<MetadataResolver> getResolvers()

Gets an immutable the list of currently registered resolvers.

Returns:

list of currently registered resolvers

setResolvers

public void setResolvers(List<MetadataResolver> newResolvers)
                  throws net.shibboleth.utilities.java.support.resolver.ResolverException

Sets the current set of 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 provider

isRequireValidMetadata

public boolean isRequireValidMetadata()

Specified by:

isRequireValidMetadata in interface MetadataResolver

setRequireValidMetadata

public void setRequireValidMetadata(boolean requireValidMetadata)

Specified by:

setRequireValidMetadata in interface MetadataResolver

getMetadataFilter

public MetadataFilter getMetadataFilter()

Specified by:

getMetadataFilter in interface MetadataResolver

setMetadataFilter

public void setMetadataFilter(MetadataFilter newFilter)

Specified by:

setMetadataFilter in interface MetadataResolver

resolveSingle

@Nullable
public EntityDescriptor resolveSingle(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(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

Specified by:

refresh in interface RefreshableMetadataResolver

Throws:

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

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