org.opensaml.saml.metadata.resolver.impl

Class AbstractDynamicMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.AbstractDynamicMetadataResolver

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>, DynamicMetadataResolver, MetadataResolver

Direct Known Subclasses:

AbstractDynamicHTTPMetadataResolver

public abstract class AbstractDynamicMetadataResolver
extends AbstractMetadataResolver
implements DynamicMetadataResolver

Abstract subclass for metadata resolvers that resolve metadata dynamically, as needed and on demand.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractDynamicMetadataResolver.BackingStoreCleanupSweeper Background maintenance task which cleans idle metadata from the backing store, and removes orphaned entity management data.
protected class	AbstractDynamicMetadataResolver.DynamicEntityBackingStore Specialized entity backing store implementation for dynamic metadata resolvers.
protected class	AbstractDynamicMetadataResolver.EntityManagementData Class holding per-entity management data.

Nested classes/interfaces inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver

AbstractMetadataResolver.EntityBackingStore

Field Summary

Fields

Modifier and Type	Field and Description
private AbstractDynamicMetadataResolver.BackingStoreCleanupSweeper	cleanupTask The backing store cleanup sweeper background task.
private Long	cleanupTaskInterval The interval in milliseconds at which the cleanup task should run.
private boolean	createdOwnTaskTimer Whether we created our own task timer during object construction.
private Logger	log Class logger.
private Long	maxIdleEntityData The maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.
private Timer	taskTimer Timer used to schedule background metadata update tasks.

Constructor Summary

Constructors

Constructor and Description
AbstractDynamicMetadataResolver(Timer backgroundTaskTimer) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	createNewBackingStore() Create a new backing store instance for EntityDescriptor data.
protected void	doDestroy()
protected abstract Iterable<EntityDescriptor>	fetchByCriteria(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Fetch metadata from an origin source based on the input criteria, store it in the backing store and then return it.
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	getBackingStore() Get the EntityDescriptor backing store currently in use by the metadata resolver.
Long	getCleanupTaskInterval() Get the interval in milliseconds at which the cleanup task should run.
Long	getMaxIdleEntityData() Get the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
protected List<EntityDescriptor>	lookupEntityID(String entityID) Get list of descriptors matching an entityID.
protected void	processNewMetadata(org.opensaml.core.xml.XMLObject root, String expectedEntityID) Process the specified new metadata document, including metadata filtering, and store the processed metadata in the backing store.
Iterable<EntityDescriptor>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
void	setCleanupTaskInterval(Long interval) Set the interval in milliseconds at which the cleanup task should run.
void	setMaxIdleEntityData(Long max) Set the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.

Methods inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver

doInitialize, filterMetadata, getMetadataFilter, getParserPool, getUnmarshallerFactory, indexEntityDescriptor, isFailFastInitialization, isRequireValidMetadata, isValid, lookupIndexedEntityID, preProcessEntitiesDescriptor, preProcessEntityDescriptor, releaseMetadataDOM, resolveSingle, setBackingStore, setFailFastInitialization, setMetadataFilter, setParserPool, setRequireValidMetadata, unmarshallMetadata

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 org.opensaml.saml.metadata.resolver.MetadataResolver

getMetadataFilter, isRequireValidMetadata, setMetadataFilter, setRequireValidMetadata

Methods inherited from interface net.shibboleth.utilities.java.support.resolver.Resolver

resolveSingle

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.

taskTimer

private Timer taskTimer

Timer used to schedule background metadata update tasks.

createdOwnTaskTimer

private boolean createdOwnTaskTimer

Whether we created our own task timer during object construction.

maxIdleEntityData

private Long maxIdleEntityData

The maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.

cleanupTaskInterval

private Long cleanupTaskInterval

The interval in milliseconds at which the cleanup task should run.

cleanupTask

private AbstractDynamicMetadataResolver.BackingStoreCleanupSweeper cleanupTask

The backing store cleanup sweeper background task.

Constructor Detail

AbstractDynamicMetadataResolver

public AbstractDynamicMetadataResolver(@Nullable
                               Timer backgroundTaskTimer)

Constructor.

Parameters:

backgroundTaskTimer - the Timer instance used to run resolver background managment tasks

Method Detail

getMaxIdleEntityData

@Nonnull
public Long getMaxIdleEntityData()

Get the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.

Defaults to: 8 hours.

Returns:

return the maximum idle time in milliseconds

setMaxIdleEntityData

public void setMaxIdleEntityData(@Nonnull
                        Long max)

Set the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.

Defaults to: 8 hours.

Parameters:

max - the maximum entity data idle time, in milliseconds

getCleanupTaskInterval

@Nonnull
public Long getCleanupTaskInterval()

Get the interval in milliseconds at which the cleanup task should run.

Defaults to: 30 minutes.

Returns:

return the interval, in milliseconds

setCleanupTaskInterval

public void setCleanupTaskInterval(@Nonnull
                          Long interval)

Set the interval in milliseconds at which the cleanup task should run.

Defaults to: 30 minutes.

Parameters:

interval - the interval to set, in milliseconds

resolve

@Nonnull
public Iterable<EntityDescriptor> resolve(@Nonnull
                                         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

fetchByCriteria

@Nonnull
@NonnullElements
protected abstract Iterable<EntityDescriptor> fetchByCriteria(@Nonnull
                                                                 net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                                       throws net.shibboleth.utilities.java.support.resolver.ResolverException

Fetch metadata from an origin source based on the input criteria, store it in the backing store and then return it.

Parameters:

criteria - the input criteria set

Returns:

the resolved metadata

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if there is a fatal error attempting to resolve the metadata

lookupEntityID

@Nonnull
@NonnullElements
protected List<EntityDescriptor> lookupEntityID(@Nonnull
                                                            String entityID)
                                         throws net.shibboleth.utilities.java.support.resolver.ResolverException

Get list of descriptors matching an entityID.

Overrides:

lookupEntityID in class AbstractMetadataResolver

Parameters:

entityID - entityID to lookup

Returns:

a list of descriptors

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if an error occurs

processNewMetadata

@Nonnull
protected void processNewMetadata(@Nonnull
                              org.opensaml.core.xml.XMLObject root,
                              @Nonnull
                              String expectedEntityID)
                           throws FilterException

Process the specified new metadata document, including metadata filtering, and store the processed metadata in the backing store.

In order to be processed successfully, the metadata (after filtering) must be an instance of EntityDescriptor and its entityID value must match the value supplied as the required expectedEntityID argument.

Parameters:

root - the root of the new metadata document being processed

expectedEntityID - the expected entityID of the resolved metadata

Throws:

FilterException - if there is a problem filtering the metadata

createNewBackingStore

@Nonnull
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore createNewBackingStore()

Create a new backing store instance for EntityDescriptor data. Subclasses may override to return a more specialized subclass type. Note this method does not make the returned backing store the effective one in use. The caller is responsible for calling AbstractMetadataResolver.setBackingStore(EntityBackingStore) to make it the effective instance in use.

Overrides:

createNewBackingStore in class AbstractMetadataResolver

Returns:

the new backing store instance

getBackingStore

@NonnullAfterInit
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore getBackingStore()

Get the EntityDescriptor backing store currently in use by the metadata resolver.

Overrides:

getBackingStore in class AbstractMetadataResolver

Returns:

the current effective entity backing store

initMetadataResolver

protected void initMetadataResolver()
                             throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Subclasses should override this method to perform any initialization logic necessary. Default implementation is a no-op.

Overrides:

initMetadataResolver in class AbstractMetadataResolver

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException - thrown if there is a problem initializing the provider

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMetadataResolver