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>
,Component
,DestructableComponent
,IdentifiableComponent
,IdentifiedComponent
,InitializableComponent
,Resolver<EntityDescriptor,CriteriaSet>
,IterableMetadataSource
,BatchMetadataResolver
,MetadataResolver
,RefreshableMetadataResolver
public class FileBackedHTTPMetadataResolver extends HTTPMetadataResolver
An HTTP 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 most recently fetched data.If the backup file does not already exist, it will be created by saving the byte[] retrieved in the HTTP fetch.
If
isInitializeFromBackupFile()
is true, then initialization will attempt to load metadata first from the backup file on disk, if it exists. If successful then the next refresh after initialization, which will attempt the full HTTP fetch, will be scheduled for the interval indicated bygetBackupFileInitNextRefreshDelay()
. This can help prevent large metadata batches from slowing down the synchronous resolver start up process, deferring the more expensive HTTP fetch operation to the asynchronous background refresh thread.
-
-
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 Description private Duration
backupFileInitNextRefreshDelay
Duration after which to schedule next refresh, when initialized from backup file.private boolean
initializedFromBackupFile
Flag indicating whether metadata load during init was from backup file.private boolean
initializeFromBackupFile
Flag indicating whether initialization should first attempt to load metadata from backup file.private boolean
initializing
Flag used to track state of whether currently initializing or not.private org.slf4j.Logger
log
Class logger.private File
metadataBackupFile
File containing the backup of the metadata.
-
Constructor Summary
Constructors Constructor Description FileBackedHTTPMetadataResolver(Timer backgroundTaskTimer, org.apache.http.client.HttpClient client, String metadataURL, String backupFilePath)
Constructor.FileBackedHTTPMetadataResolver(org.apache.http.client.HttpClient client, String metadataURL, String backupFilePath)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Duration
computeNextRefreshDelay(Instant expectedExpiration)
Computes the delay until the next refresh time based on the current metadata's expiration time and the refresh interval floor.protected void
doDestroy()
protected byte[]
fetchMetadata()
Gets the metadata document from the remote server.Duration
getBackupFileInitNextRefreshDelay()
Get the duration after which to schedule next refresh, when initialized from backup file.protected void
initMetadataResolver()
Subclasses should override this method to perform any initialization logic necessary.boolean
isInitializedFromBackupFile()
Get the flag indicating whether metadata load during initialization was from backup file.boolean
isInitializeFromBackupFile()
Get the flag indicating whether initialization should first attempt to load metadata from backup file, if it exists.protected MetadataFilterContext
newFilterContext()
Get a new instance ofMetadataFilterContext
to be used when filtering metadata.protected void
postProcessMetadata(byte[] metadataBytes, Document metadataDom, XMLObject originalMetadata, XMLObject filteredMetadata)
Post-processing hook called after new metadata has been unmarshalled, filtered, and the DOM released (from theXMLObject
) but before the metadata is saved off.protected void
setBackupFile(String backupFilePath)
Sets the file used to backup metadata.void
setBackupFileInitNextRefreshDelay(Duration delay)
Set the duration after which to schedule next refresh, when initialized from backup file.void
setInitializeFromBackupFile(boolean flag)
Set the flag indicating whether initialization should first attempt to load metadata from backup file, if it exists.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, getHttpClientSecurityParameters, getMetadataBytesFromResponse, getMetadataIdentifier, getMetadataURI, processConditionalRetrievalHeaders, setHttpClientSecurityParameters
-
Methods inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractReloadingMetadataResolver
getExpirationTime, getExpirationWarningThreshold, getLastFailureCause, getLastRefresh, getLastSuccessfulRefresh, getLastUpdate, getMaxRefreshDelay, getMinRefreshDelay, getNextRefresh, getRefreshDelayFactor, inputstreamToByteArray, processCachedMetadata, processNewMetadata, processNonExpiredMetadata, processPreExpiredMetadata, refresh, setCacheSourceMetadata, setExpirationWarningThreshold, setMaxRefreshDelay, setMinRefreshDelay, setRefreshDelayFactor, unmarshallMetadata, wasLastRefreshSuccess
-
Methods inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractBatchMetadataResolver
createNewBackingStore, getBackingStore, getCachedFilteredMetadata, getCachedOriginalMetadata, getIndexes, getRootValidUntil, indexEntityDescriptor, isCacheSourceMetadata, isResolveViaPredicatesOnly, isRootValid, iterator, lookupByIndexes, preProcessNewMetadata, resolve, setIndexes, setResolveViaPredicatesOnly
-
Methods inherited from class org.opensaml.saml.metadata.resolver.impl.AbstractMetadataResolver
doInitialize, filterMetadata, getCriterionPredicateRegistry, getLogPrefix, getMetadataFilter, getParserPool, getUnmarshallerFactory, isFailFastInitialization, isRequireValidMetadata, isSatisfyAnyPredicates, isUseDefaultPredicateRegistry, isValid, lookupEntityID, lookupIndexedEntityID, predicateFilterCandidates, preProcessEntitiesDescriptor, preProcessEntityDescriptor, releaseMetadataDOM, removeByEntityID, resolveSingle, setBackingStore, setCriterionPredicateRegistry, setFailFastInitialization, setMetadataFilter, setParserPool, setRequireValidMetadata, setSatisfyAnyPredicates, setUseDefaultPredicateRegistry, 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 net.shibboleth.utilities.java.support.component.IdentifiedComponent
getId
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
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
-
-
-
-
Field Detail
-
log
@Nonnull private final org.slf4j.Logger log
Class logger.
-
metadataBackupFile
@Nullable private File metadataBackupFile
File containing the backup of the metadata.
-
initializing
private boolean initializing
Flag used to track state of whether currently initializing or not.
-
initializeFromBackupFile
private boolean initializeFromBackupFile
Flag indicating whether initialization should first attempt to load metadata from backup file.
-
initializedFromBackupFile
private boolean initializedFromBackupFile
Flag indicating whether metadata load during init was from backup file.
-
backupFileInitNextRefreshDelay
@Nonnull private Duration backupFileInitNextRefreshDelay
Duration after which to schedule next refresh, when initialized from backup file.
-
-
Constructor Detail
-
FileBackedHTTPMetadataResolver
public FileBackedHTTPMetadataResolver(org.apache.http.client.HttpClient client, String metadataURL, String backupFilePath) throws ResolverException
Constructor.- Parameters:
client
- HTTP client used to fetch remote metadatametadataURL
- the URL to fetch the metadatabackupFilePath
- the file that will keep a backup copy of the metadata,- Throws:
ResolverException
- thrown if the URL is not a valid URL, the metadata can not be retrieved from the URL
-
FileBackedHTTPMetadataResolver
public FileBackedHTTPMetadataResolver(Timer backgroundTaskTimer, org.apache.http.client.HttpClient client, String metadataURL, String backupFilePath) throws ResolverException
Constructor.- Parameters:
client
- HTTP client used to fetch remote metadatabackgroundTaskTimer
- timer used to schedule background metadata refresh tasksmetadataURL
- the URL to fetch the metadatabackupFilePath
- the file that will keep a backup copy of the metadata,- Throws:
ResolverException
- thrown if the URL is not a valid URL, the metadata can not be retrieved from the URL
-
-
Method Detail
-
isInitializedFromBackupFile
public boolean isInitializedFromBackupFile()
Get the flag indicating whether metadata load during initialization was from backup file.- Returns:
- true if initial load was from backup file, false otherwise
-
isInitializeFromBackupFile
public boolean isInitializeFromBackupFile()
Get the flag indicating whether initialization should first attempt to load metadata from backup file, if it exists.Defaults to: true.
- Returns:
- true if should initialize from backup file, false otherwise
-
setInitializeFromBackupFile
public void setInitializeFromBackupFile(boolean flag)
Set the flag indicating whether initialization should first attempt to load metadata from backup file, if it exists.Defaults to: true.
- Parameters:
flag
- true if should initialize from backup file, false otherwise
-
getBackupFileInitNextRefreshDelay
@Nonnull public Duration getBackupFileInitNextRefreshDelay()
Get the duration after which to schedule next refresh, when initialized from backup file.Defaults to 5s.
- Returns:
- the duration
-
setBackupFileInitNextRefreshDelay
public void setBackupFileInitNextRefreshDelay(@Nonnull Duration delay)
Set the duration after which to schedule next refresh, when initialized from backup file.Defaults to 5s.
- Parameters:
delay
- the next refresh delay
-
doDestroy
protected void doDestroy()
- Overrides:
doDestroy
in classHTTPMetadataResolver
-
initMetadataResolver
protected void initMetadataResolver() throws ComponentInitializationException
Subclasses should override this method to perform any initialization logic necessary. Default implementation is a no-op.- Overrides:
initMetadataResolver
in classAbstractReloadingMetadataResolver
- Throws:
ComponentInitializationException
- thrown if there is a problem initializing the provider
-
setBackupFile
protected void setBackupFile(String backupFilePath) throws 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:
ResolverException
- thrown if the backup file is not read/writable or creatable
-
validateBackupFile
protected void validateBackupFile(File backupFile) throws 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:
ResolverException
- if file does not pass basic properties required of a metadata backup file
-
fetchMetadata
protected byte[] fetchMetadata() throws ResolverException
Gets the metadata document from the remote server.- Overrides:
fetchMetadata
in classHTTPMetadataResolver
- Returns:
- the metadata from remote server, or null if the metadata document has not changed since the last retrieval
- Throws:
ResolverException
- thrown if there is a problem retrieving the metadata from the remote server
-
newFilterContext
protected MetadataFilterContext newFilterContext()
Get a new instance ofMetadataFilterContext
to be used when filtering metadata.This default implementation will just return an empty context. Subclasses would override to add contextual info specific to the implementation.
- Overrides:
newFilterContext
in classAbstractMetadataResolver
- Returns:
- the new filter context instance
-
computeNextRefreshDelay
@Nonnull protected Duration computeNextRefreshDelay(@Nullable Instant expectedExpiration)
Computes the delay until the next refresh time based on the current metadata's expiration time and the refresh interval floor.- Overrides:
computeNextRefreshDelay
in classAbstractReloadingMetadataResolver
- Parameters:
expectedExpiration
- the time when the metadata is expected to expire and need refreshing- Returns:
- delay until the next refresh time
-
postProcessMetadata
protected void postProcessMetadata(byte[] metadataBytes, Document metadataDom, XMLObject originalMetadata, XMLObject filteredMetadata) throws ResolverException
Post-processing hook called after new metadata has been unmarshalled, filtered, and the DOM released (from theXMLObject
) 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 classAbstractReloadingMetadataResolver
- Parameters:
metadataBytes
- original raw metadata bytes retrieved viaAbstractReloadingMetadataResolver.fetchMetadata()
metadataDom
- original metadata after it has been parsed in to a DOM documentoriginalMetadata
- original metadata prior to being filtered, with its DOM releasedfilteredMetadata
- metadata after it has been run through all registered filters and its DOM released- Throws:
ResolverException
- thrown if there is a problem with the provided data
-
-