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()	Attempt to clear all data from the internal cache of the resolver.
void	clear(String entityID)	Attempt to clear data from the internal cache of the resolver for the specified entityID.
protected void	doDestroy()
protected void	doInitialize()
Throwable	getLastFailureCause()	Gets the reason the last refresh failed.
Instant	getLastRefresh()	Gets the time the last refresh cycle occurred.
Instant	getLastSuccessfulRefresh()	Gets the time the last successful refresh cycle occurred.
Instant	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()	Gets 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(CriteriaSet criteria)
EntityDescriptor	resolveSingle(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<MetadataResolver> newResolvers)	Sets the current set of metadata resolvers.
Boolean	wasLastRefreshSuccess()	Gets whether the last refresh cycle was successful.

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 Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

resolvers

@Nonnull
@NonnullElements
private List<MetadataResolver> resolvers

Resolvers composed by this resolver.

Constructor Details

CompositeMetadataResolver

public CompositeMetadataResolver()

Constructor.

Method Details

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()

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

@Nullable
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(@Nullable
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

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

Attempt to clear all data from the internal cache of the resolver.

Specified by:

clear in interface ClearableMetadataResolver

Throws:

ResolverException - if the clear operation was unsuccessful

clear

public void clear(String entityID)
           throws ResolverException

Attempt to clear data from the internal cache of the resolver for the specified entityID.

Specified by:

clear in interface ClearableMetadataResolver

Parameters:

entityID - the target entityID

Throws:

ResolverException - if the clear operation was unsuccessful

refresh

public void refresh()
             throws 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:

ResolverException - if the refresh operation was unsuccessful

getLastUpdate

@Nullable
public Instant 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 Instant getLastRefresh()

Gets the time the last refresh cycle occurred.

Specified by:

getLastRefresh in interface RefreshableMetadataResolver

Returns:

time the last refresh cycle occurred

getLastSuccessfulRefresh

public Instant getLastSuccessfulRefresh()

Gets the time the last successful refresh cycle occurred.

Specified by:

getLastSuccessfulRefresh in interface RefreshableMetadataResolver

Returns:

time the last successful refresh cycle occurred

wasLastRefreshSuccess

public Boolean wasLastRefreshSuccess()

Gets whether the last refresh cycle was successful.

Specified by:

wasLastRefreshSuccess in interface RefreshableMetadataResolver

Returns:

true if last refresh cycle was successful, false if not

getLastFailureCause

public Throwable getLastFailureCause()

Gets the reason the last refresh failed.

Specified by:

getLastFailureCause in interface RefreshableMetadataResolver

Returns:

reason the last refresh failed or null if the last refresh was successful