org.opensaml.saml.metadata.resolver.impl

Class FileBackedHTTPMetadataResolver

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

org.opensaml.saml.metadata.resolver.impl.FileBackedHTTPMetadataResolver

All Implemented Interfaces:

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 FileBackedHTTPMetadataResolver
extends HTTPMetadataResolver

A URL metadata provider that caches a copy of the retrieved metadata to disk so that, in the event that the metadata may not be pulled from the URL it may be pulled from disk using the last fetched data. If the backing file does not already exist it will be created. It is the responsibility of the caller to re-initialize, via AbstractInitializableComponent.initialize(), if any properties of this provider are changed.

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 Logger	log Class logger.
private File	metadataBackupFile File containing the backup of the metadata.

Constructor Summary

Constructors

Constructor and Description
FileBackedHTTPMetadataResolver(HttpClient client, String metadataURL, String backupFilePath) Constructor.
FileBackedHTTPMetadataResolver(Timer backgroundTaskTimer, HttpClient client, String metadataURL, String backupFilePath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected byte[]	fetchMetadata() Gets the metadata document from the remote server.
protected void	initMetadataResolver() Subclasses should override this method to perform any initialization logic necessary.
protected void	postProcessMetadata(byte[] metadataBytes, Document metadataDom, org.opensaml.core.xml.XMLObject originalMetadata, org.opensaml.core.xml.XMLObject filteredMetadata) Post-processing hook called after new metadata has been unmarshalled, filtered, and the DOM released (from the XMLObject) but before the metadata is saved off.
protected void	setBackupFile(String backupFilePath) Sets the file used to backup metadata.
protected void	validateBackupFile(File backupFile) Validate the basic properties of the specified metadata backup file, for example that it exists and/or can be created; that it is not a directory; and that it is readable and writable.

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

buildHttpClientContext, buildHttpGet, getMetadataBytesFromResponse, getMetadataIdentifier, getMetadataURI, processConditionalRetrievalHeaders, setBasicCredentials, setBasicCredentialsWithScope

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

computeNextRefreshDelay, getExpirationTime, getLastRefresh, getLastUpdate, getMaxRefreshDelay, getMinRefreshDelay, getNextRefresh, getRefreshDelayFactor, inputstreamToByteArray, 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

Field Detail

log

@Nonnull
private final Logger log

Class logger.

metadataBackupFile

@Nullable
private File metadataBackupFile

File containing the backup of the metadata.

Constructor Detail

FileBackedHTTPMetadataResolver

public FileBackedHTTPMetadataResolver(HttpClient client,
                              String metadataURL,
                              String backupFilePath)
                               throws net.shibboleth.utilities.java.support.resolver.ResolverException

Constructor.

Parameters:

client - HTTP client used to fetch remote metadata

metadataURL - the URL to fetch the metadata

backupFilePath - the file that will keep a backup copy of the metadata,

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if the URL is not a valid URL, the metadata can not be retrieved from the URL

FileBackedHTTPMetadataResolver

public FileBackedHTTPMetadataResolver(Timer backgroundTaskTimer,
                              HttpClient client,
                              String metadataURL,
                              String backupFilePath)
                               throws net.shibboleth.utilities.java.support.resolver.ResolverException

Constructor.

Parameters:

client - HTTP client used to fetch remote metadata

backgroundTaskTimer - timer used to schedule background metadata refresh tasks

metadataURL - the URL to fetch the metadata

backupFilePath - the file that will keep a backup copy of the metadata,

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if the URL is not a valid URL, the metadata can not be retrieved from the URL

Method Detail

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class HTTPMetadataResolver

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 AbstractReloadingMetadataResolver

Throws:

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

setBackupFile

protected void setBackupFile(String backupFilePath)
                      throws net.shibboleth.utilities.java.support.resolver.ResolverException

Sets the file used to backup metadata. The given file path is checked to see if it is a read/writable file if it exists or if can be created if it does not exist.

Parameters:

backupFilePath - path to the backup file

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if the backup file is not read/writable or creatable

validateBackupFile

protected void validateBackupFile(File backupFile)
                           throws net.shibboleth.utilities.java.support.resolver.ResolverException

Validate the basic properties of the specified metadata backup file, for example that it exists and/or can be created; that it is not a directory; and that it is readable and writable.

Parameters:

backupFile - the file to evaluate

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - if file does not pass basic properties required of a metadata backup file

fetchMetadata

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

Gets the metadata document from the remote server.

Overrides:

fetchMetadata in class HTTPMetadataResolver

Returns:

the metadata from remote server, or null if the metadata document has not changed since the last retrieval

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem retrieving the metadata from the remote server

postProcessMetadata

protected void postProcessMetadata(byte[] metadataBytes,
                       Document metadataDom,
                       org.opensaml.core.xml.XMLObject originalMetadata,
                       org.opensaml.core.xml.XMLObject filteredMetadata)
                            throws net.shibboleth.utilities.java.support.resolver.ResolverException

Post-processing hook called after new metadata has been unmarshalled, filtered, and the DOM released (from the XMLObject) but before the metadata is saved off. Any exception thrown by this hook will cause the retrieved metadata to be discarded. The default implementation of this method is a no-op

Overrides:

postProcessMetadata in class AbstractReloadingMetadataResolver

Parameters:

metadataBytes - original raw metadata bytes retrieved via AbstractReloadingMetadataResolver.fetchMetadata()

metadataDom - original metadata after it has been parsed in to a DOM document

originalMetadata - original metadata prior to being filtered, with its DOM released

filteredMetadata - metadata after it has been run through all registered filters and its DOM released

Throws:

net.shibboleth.utilities.java.support.resolver.ResolverException - thrown if there is a problem with the provided data