org.opensaml.saml.metadata.resolver.impl

Class CompositeMetadataResolver

java.lang.Object

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

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

org.opensaml.saml.metadata.resolver.impl.CompositeMetadataResolver

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, 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>, ClearableMetadataResolver, MetadataResolver, RefreshableMetadataResolver

public class CompositeMetadataResolver
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent
implements MetadataResolver, RefreshableMetadataResolver, ClearableMetadataResolver

A MetadataResolver implementation that answers requests by composing the answers of child MetadataResolvers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	CompositeMetadataResolver.CompositeMetadataResolverIterable Iterable implementation that provides an Iterator that lazily iterates over each composed resolver.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private List<MetadataResolver>	resolvers Resolvers composed by this resolver.

Constructor Summary

Constructors

Constructor and Description
CompositeMetadataResolver() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
void	clear(String entityID)
protected void	doDestroy()
protected void	doInitialize()
org.joda.time.DateTime	getLastRefresh()
org.joda.time.DateTime	getLastUpdate()
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.AbstractIdentifiedInitializableComponent

getId, setId

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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

resolvers

@Nonnull
@NonnullElements
private List<MetadataResolver> resolvers

Resolvers composed by this resolver.

Constructor Detail

CompositeMetadataResolver

public CompositeMetadataResolver()

Constructor.

Method Detail

getResolvers

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

Gets an immutable the list of currently registered resolvers.

Returns:

list of currently registered resolvers

setResolvers

public void setResolvers(@Nonnull@NonnullElements
                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

@Nullable
public MetadataFilter getMetadataFilter()

Specified by:

getMetadataFilter in interface MetadataResolver

setMetadataFilter

public void setMetadataFilter(@Nullable
                     MetadataFilter newFilter)

Specified by:

setMetadataFilter in interface MetadataResolver

resolve

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

resolveSingle

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

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

clear

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

Specified by:

clear in interface ClearableMetadataResolver

Throws:

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

clear

public void clear(String entityID)
           throws net.shibboleth.utilities.java.support.resolver.ResolverException

Specified by:

clear in interface ClearableMetadataResolver

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

getLastUpdate

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

Specified by:

getLastUpdate in interface RefreshableMetadataResolver

getLastRefresh

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

Specified by:

getLastRefresh in interface RefreshableMetadataResolver