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 expired and 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 java.lang.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 org.slf4j.Logger	log Class logger.
private java.lang.Long	maxCacheDuration Maximum cache duration.
private java.lang.Long	maxIdleEntityData The maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.
private java.lang.Long	minCacheDuration Minimum cache duration.
private java.lang.Float	refreshDelayFactor Factor used to compute when the next refresh interval will occur.
private boolean	removeIdleEntityData Flag indicating whether idle entity data should be removed.
private java.util.Timer	taskTimer Timer used to schedule background metadata update tasks.

Constructor Summary

Constructors

Constructor and Description
AbstractDynamicMetadataResolver(java.util.Timer backgroundTaskTimer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected org.joda.time.DateTime	computeExpirationTime(EntityDescriptor entityDescriptor, org.joda.time.DateTime now) Compute the effective expiration time for the specified metadata.
protected org.joda.time.DateTime	computeRefreshTriggerTime(org.joda.time.DateTime expirationTime, org.joda.time.DateTime nowDateTime) Compute the refresh trigger time.
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	createNewBackingStore() Create a new backing store instance for EntityDescriptor data.
protected void	doDestroy()
protected abstract XMLObject	fetchFromOriginSource(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria) Fetch the metadata from the origin source.
protected AbstractDynamicMetadataResolver.DynamicEntityBackingStore	getBackingStore() Get the EntityDescriptor backing store currently in use by the metadata resolver.
java.lang.Long	getCleanupTaskInterval() Get the interval in milliseconds at which the cleanup task should run.
java.lang.Long	getMaxCacheDuration() Get the maximum cache duration for metadata.
java.lang.Long	getMaxIdleEntityData() Get the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.
java.lang.Long	getMinCacheDuration() Get the minimum cache duration for metadata.
java.lang.Float	getRefreshDelayFactor() Gets the delay factor used to compute the next refresh time.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
boolean	isRemoveIdleEntityData() Get the flag indicating whether idle entity data should be removed.
protected java.util.List<EntityDescriptor>	lookupEntityID(java.lang.String entityID) Get list of descriptors matching an entityID.
protected void	preProcessEntityDescriptor(EntityDescriptor entityDescriptor, AbstractMetadataResolver.EntityBackingStore backingStore) Pre-process the specified entity descriptor, updating the specified entity backing store instance as necessary.
protected void	processNewMetadata(XMLObject root, java.lang.String expectedEntityID) Process the specified new metadata document, including metadata filtering, and store the processed metadata in the backing store.
java.lang.Iterable<EntityDescriptor>	resolve(net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
protected java.lang.Iterable<EntityDescriptor>	resolveFromOriginSource(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.
void	setCleanupTaskInterval(java.lang.Long interval) Set the interval in milliseconds at which the cleanup task should run.
void	setMaxCacheDuration(java.lang.Long duration) Set the maximum cache duration for metadata.
void	setMaxIdleEntityData(java.lang.Long max) Set the maximum idle time in milliseconds for which the resolver will keep data for a given entityID, before it is removed.
void	setMinCacheDuration(java.lang.Long duration) Set the minimum cache duration for metadata.
void	setRefreshDelayFactor(java.lang.Float factor) Sets the delay factor used to compute the next refresh time.
void	setRemoveIdleEntityData(boolean flag) Set the flag indicating whether idle entity data should be removed.
protected boolean	shouldAttemptRefresh(AbstractDynamicMetadataResolver.EntityManagementData mgmtData) Determine whether should attempt to refresh the metadata, based on stored refresh trigger time.

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

doInitialize, filterMetadata, getMetadataFilter, getParserPool, getUnmarshallerFactory, indexEntityDescriptor, isFailFastInitialization, isRequireValidMetadata, isValid, lookupIndexedEntityID, preProcessEntitiesDescriptor, releaseMetadataDOM, removeByEntityID, 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

Field Detail

log

private final org.slf4j.Logger log

Class logger.

taskTimer

private java.util.Timer taskTimer

Timer used to schedule background metadata update tasks.

createdOwnTaskTimer

private boolean createdOwnTaskTimer

Whether we created our own task timer during object construction.

minCacheDuration

@Duration
 @Positive
private java.lang.Long minCacheDuration

Minimum cache duration.

maxCacheDuration

@Duration
 @Positive
private java.lang.Long maxCacheDuration

Maximum cache duration.

refreshDelayFactor

@Positive
private java.lang.Float refreshDelayFactor

Factor used to compute when the next refresh interval will occur. Default value: 0.75

maxIdleEntityData

@Duration
 @Positive
private java.lang.Long maxIdleEntityData

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

removeIdleEntityData

private boolean removeIdleEntityData

Flag indicating whether idle entity data should be removed.

cleanupTaskInterval

@Duration
 @Positive
private java.lang.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
                                       java.util.Timer backgroundTaskTimer)

Constructor.

Parameters:

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

Method Detail

getMinCacheDuration

@Nonnull
public java.lang.Long getMinCacheDuration()

Get the minimum cache duration for metadata.

Defaults to: 10 minutes.

Returns:

the minimum cache duration, in milliseconds

setMinCacheDuration

public void setMinCacheDuration(@Nonnull
                                java.lang.Long duration)

Set the minimum cache duration for metadata.

Defaults to: 10 minutes.

Parameters:

duration - the minimum cache duration, in milliseconds

getMaxCacheDuration

@Nonnull
public java.lang.Long getMaxCacheDuration()

Get the maximum cache duration for metadata.

Defaults to: 8 hours.

Returns:

the maximum cache duration, in milliseconds

setMaxCacheDuration

public void setMaxCacheDuration(@Nonnull
                                java.lang.Long duration)

Set the maximum cache duration for metadata.

Defaults to: 8 hours.

Parameters:

duration - the maximum cache duration, in milliseconds

getRefreshDelayFactor

public java.lang.Float getRefreshDelayFactor()

Gets the delay factor used to compute the next refresh time.

Defaults to: 0.75.

Returns:

delay factor used to compute the next refresh time

setRefreshDelayFactor

public void setRefreshDelayFactor(java.lang.Float factor)

Sets the delay factor used to compute the next refresh time. The delay must be between 0.0 and 1.0, exclusive.

Defaults to: 0.75.

Parameters:

factor - delay factor used to compute the next refresh time

isRemoveIdleEntityData

public boolean isRemoveIdleEntityData()

Get the flag indicating whether idle entity data should be removed.

Returns:

true if idle entity data should be removed, false otherwise

setRemoveIdleEntityData

public void setRemoveIdleEntityData(boolean flag)

Set the flag indicating whether idle entity data should be removed.

Parameters:

flag - true if idle entity data should be removed, false otherwise

getMaxIdleEntityData

@Nonnull
public java.lang.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
                                 java.lang.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 java.lang.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
                                   java.lang.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 java.lang.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

resolveFromOriginSource

@Nonnull
 @NonnullElements
protected java.lang.Iterable<EntityDescriptor> resolveFromOriginSource(@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

fetchFromOriginSource

@Nullable
protected abstract XMLObject fetchFromOriginSource(@Nonnull
                                                             net.shibboleth.utilities.java.support.resolver.CriteriaSet criteria)
                                                      throws java.io.IOException

Fetch the metadata from the origin source.

Parameters:

criteria - the input criteria set

Returns:

the resolved metadata root XMLObject, or null if metadata could not be fetched

Throws:

java.io.IOException - if there is a fatal error fetching metadata from the origin source

lookupEntityID

@Nonnull
 @NonnullElements
protected java.util.List<EntityDescriptor> lookupEntityID(@Nonnull
                                                                                     java.lang.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
                                           XMLObject root,
                                           @Nonnull
                                           java.lang.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

preProcessEntityDescriptor

protected void preProcessEntityDescriptor(@Nonnull
                                          EntityDescriptor entityDescriptor,
                                          @Nonnull
                                          AbstractMetadataResolver.EntityBackingStore backingStore)

Pre-process the specified entity descriptor, updating the specified entity backing store instance as necessary.

Overrides:

preProcessEntityDescriptor in class AbstractMetadataResolver

Parameters:

entityDescriptor - the target entity descriptor to process

backingStore - the backing store instance to update

computeExpirationTime

@Nonnull
protected org.joda.time.DateTime computeExpirationTime(@Nonnull
                                                                EntityDescriptor entityDescriptor,
                                                                @Nonnull
                                                                org.joda.time.DateTime now)

Compute the effective expiration time for the specified metadata.

Parameters:

entityDescriptor - the EntityDescriptor instance to evaluate

now - the current date time instant

Returns:

the effective expiration time for the metadata

computeRefreshTriggerTime

@Nonnull
protected org.joda.time.DateTime computeRefreshTriggerTime(@Nullable
                                                                    org.joda.time.DateTime expirationTime,
                                                                    @Nonnull
                                                                    org.joda.time.DateTime nowDateTime)

Compute the refresh trigger time.

Parameters:

expirationTime - the time at which the metadata effectively expires

nowDateTime - the current date time instant

Returns:

the time after which refresh attempt(s) should be made

shouldAttemptRefresh

protected boolean shouldAttemptRefresh(@Nonnull
                                       AbstractDynamicMetadataResolver.EntityManagementData mgmtData)

Determine whether should attempt to refresh the metadata, based on stored refresh trigger time.

Parameters:

mgmtData - the entity'd management data

Returns:

true if should attempt refresh, false otherwise

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