Package 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:

Component, DestructableComponent, IdentifiedComponent, InitializableComponent, Resolver<EntityDescriptor,CriteriaSet>, ClearableMetadataResolver, MetadataResolver, RefreshableMetadataResolver

public class CompositeMetadataResolver
extends 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	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	Description
private org.slf4j.Logger	log	Class logger.
private List<MetadataResolver>	resolvers	Resolvers composed by this resolver.

Constructor Summary

Constructors

Constructor	Description
CompositeMetadataResolver()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clear(String entityID)
protected void	doDestroy()
protected void	doInitialize()
Throwable	getLastFailureCause()
Instant	getLastRefresh()
Instant	getLastSuccessfulRefresh()
Instant	getLastUpdate()
MetadataFilter	getMetadataFilter()
List<MetadataResolver>	getResolvers()	Gets an immutable the list of currently registered resolvers.
boolean	isRequireValidMetadata()
void	refresh()
Iterable<EntityDescriptor>	resolve(CriteriaSet criteria)
EntityDescriptor	resolveSingle(CriteriaSet criteria)
void	setMetadataFilter(MetadataFilter newFilter)
void	setRequireValidMetadata(boolean requireValidMetadata)
void	setResolvers(List<MetadataResolver> newResolvers)	Sets the current set of metadata resolvers.
Boolean	wasLastRefreshSuccess()

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 org.slf4j.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 ResolverException

Sets the current set of metadata resolvers.

Parameters:

newResolvers - the metadata resolvers to use

Throws:

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
                                          CriteriaSet criteria)
                                   throws ResolverException

Specified by:

resolve in interface Resolver<EntityDescriptor,CriteriaSet>

Throws:

ResolverException

resolveSingle

public EntityDescriptor resolveSingle(@Nullable
                                      CriteriaSet criteria)
                               throws ResolverException

Specified by:

resolveSingle in interface Resolver<EntityDescriptor,CriteriaSet>

Throws:

ResolverException

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractInitializableComponent

clear

public void clear()
           throws ResolverException

Specified by:

clear in interface ClearableMetadataResolver

Throws:

ResolverException

clear

public void clear(String entityID)
           throws ResolverException

Specified by:

clear in interface ClearableMetadataResolver

Throws:

ResolverException

refresh

public void refresh()
             throws ResolverException

Specified by:

refresh in interface RefreshableMetadataResolver

Throws:

ResolverException

getLastUpdate

@Nullable
public Instant getLastUpdate()

Specified by:

getLastUpdate in interface RefreshableMetadataResolver

getLastRefresh

@Nullable
public Instant getLastRefresh()

Specified by:

getLastRefresh in interface RefreshableMetadataResolver

getLastSuccessfulRefresh

public Instant getLastSuccessfulRefresh()

Specified by:

getLastSuccessfulRefresh in interface RefreshableMetadataResolver

wasLastRefreshSuccess

public Boolean wasLastRefreshSuccess()

Specified by:

wasLastRefreshSuccess in interface RefreshableMetadataResolver

getLastFailureCause

public Throwable getLastFailureCause()

Specified by:

getLastFailureCause in interface RefreshableMetadataResolver