Package org.opensaml.saml.metadata.resolver.impl

Class CompositeMetadataResolver

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.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.

Note: This appears to be unused, and contained a number of bugs that may or may not have been fully corrected.

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 final org.slf4j.Logger	log	Class logger.
private List<MetadataResolver>	resolvers	Resolvers composed by this resolver.
private String	resolverType	Resolver type.

Constructor Summary

Constructors

Constructor	Description
CompositeMetadataResolver()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	clear()
void	clear(String entityID)
Throwable	getLastFailureCause()
Instant	getLastRefresh()
Instant	getLastSuccessfulRefresh()
Instant	getLastUpdate()
MetadataFilter	getMetadataFilter()
List<MetadataResolver>	getResolvers()	Gets an immutable the list of currently registered resolvers.
String	getType()
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.
void	setType(String type)	Sets the type of this resolver for reporting/logging.
Boolean	wasLastRefreshSuccess()

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

doInitialize, ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, setId

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, 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.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

resolverType

@Nullable
@NotEmpty
private String resolverType

Resolver type.

resolvers

@Nonnull
private List<MetadataResolver> resolvers

Resolvers composed by this resolver.

Constructor Details

CompositeMetadataResolver

public CompositeMetadataResolver()

Constructor.

Method Details

getResolvers

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

getType

@Nullable
@NotEmpty
public String getType()

Specified by:

getType in interface MetadataResolver

setType

public void setType(@Nullable @NotEmpty
 String type)

Sets the type of this resolver for reporting/logging.

Parameters:

type - type to set

Since:

5.0.0

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

@Nonnull
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

clear

public void clear()
           throws ResolverException

Specified by:

clear in interface ClearableMetadataResolver

Throws:

ResolverException

clear

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

@Nullable
public Instant getLastSuccessfulRefresh()

Specified by:

getLastSuccessfulRefresh in interface RefreshableMetadataResolver

wasLastRefreshSuccess

@Nullable
public Boolean wasLastRefreshSuccess()

Specified by:

wasLastRefreshSuccess in interface RefreshableMetadataResolver

getLastFailureCause

@Nullable
public Throwable getLastFailureCause()

Specified by:

getLastFailureCause in interface RefreshableMetadataResolver