org.opensaml.saml.metadata.resolver.impl

Class ResourceBackedMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.AbstractReloadingMetadataResolver

org.opensaml.saml.metadata.resolver.impl.ResourceBackedMetadataResolver

All Implemented Interfaces:

java.lang.Iterable<EntityDescriptor>, 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>, IterableMetadataSource, BatchMetadataResolver, MetadataResolver, RefreshableMetadataResolver

public class ResourceBackedMetadataResolver
extends AbstractReloadingMetadataResolver

A metadata provider that reads metadata from a {#link Resource.

Since:

2.2

Nested Class Summary

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

AbstractBatchMetadataResolver.BatchEntityBackingStore

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 org.slf4j.Logger	log Class logger.
private net.shibboleth.utilities.java.support.resource.Resource	metadataResource Resource from which metadata is read.

Constructor Summary

Constructors

Constructor and Description
ResourceBackedMetadataResolver(net.shibboleth.utilities.java.support.resource.Resource resource) Constructor.
ResourceBackedMetadataResolver(java.util.Timer timer, net.shibboleth.utilities.java.support.resource.Resource resource) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy()
protected byte[]	fetchMetadata() Fetches metadata from a source.
protected java.lang.String	getMetadataIdentifier() Gets an identifier which may be used to distinguish this metadata in logging statements.

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

computeNextRefreshDelay, getExpirationTime, getLastRefresh, getLastUpdate, getMaxRefreshDelay, getMinRefreshDelay, getNextRefresh, getRefreshDelayFactor, initMetadataResolver, inputstreamToByteArray, postProcessMetadata, processCachedMetadata, processNewMetadata, processNonExpiredMetadata, processPreExpiredMetadata, refresh, setCacheSourceMetadata, setMaxRefreshDelay, setMinRefreshDelay, setRefreshDelayFactor, unmarshallMetadata

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

createNewBackingStore, getBackingStore, getCachedFilteredMetadata, getCachedOriginalMetadata, isCacheSourceMetadata, iterator, preProcessNewMetadata, resolve

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

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

resolve, resolveSingle

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

log

private final org.slf4j.Logger log

Class logger.

metadataResource

private net.shibboleth.utilities.java.support.resource.Resource metadataResource

Resource from which metadata is read.

Constructor Detail

ResourceBackedMetadataResolver

public ResourceBackedMetadataResolver(java.util.Timer timer,
                                      net.shibboleth.utilities.java.support.resource.Resource resource)
                               throws java.io.IOException

Constructor.

Parameters:

resource - resource from which to read the metadata file.

timer - task timer used to schedule metadata refresh tasks

Throws:

java.io.IOException - thrown if there is a problem retrieving information about the resource

ResourceBackedMetadataResolver

public ResourceBackedMetadataResolver(net.shibboleth.utilities.java.support.resource.Resource resource)
                               throws java.io.IOException

Constructor.

Parameters:

resource - resource from which to read the metadata file.

Throws:

java.io.IOException - thrown if there is a problem retrieving information about the resource

Method Detail

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractReloadingMetadataResolver

getMetadataIdentifier

protected java.lang.String getMetadataIdentifier()

Gets an identifier which may be used to distinguish this metadata in logging statements.

Specified by:

getMetadataIdentifier in class AbstractReloadingMetadataResolver

Returns:

identifier which may be used to distinguish this metadata in logging statements

fetchMetadata

protected byte[] fetchMetadata()
                        throws net.shibboleth.utilities.java.support.resolver.ResolverException

Fetches metadata from a source.

Specified by:

fetchMetadata in class AbstractReloadingMetadataResolver

Returns:

the fetched metadata, or null if the metadata is known not to have changed since the last retrieval

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem fetching the metadata