org.opensaml.saml2.metadata.provider

クラス FilesystemMetadataProvider

java.lang.Object

org.opensaml.saml2.metadata.provider.BaseMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

org.opensaml.saml2.metadata.provider.AbstractReloadingMetadataProvider

org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider

すべての実装されたインタフェース:

MetadataProvider, ObservableMetadataProvider

public class FilesystemMetadataProvider
extends AbstractReloadingMetadataProvider

A metadata provider that pulls metadata from a file on the local filesystem. This metadata provider periodically checks to see if the read metadata file has changed. The delay between each refresh interval is calculated as follows. If no validUntil or cacheDuration is present then the AbstractReloadingMetadataProvider.getMaxRefreshDelay() value is used. Otherwise, the earliest refresh interval of the metadata file is checked by looking for the earliest of all the validUntil attributes and cacheDuration attributes. If that refresh interval is larger than the max refresh delay then AbstractReloadingMetadataProvider.getMaxRefreshDelay() is used. If that number is smaller than the min refresh delay then AbstractReloadingMetadataProvider.getMinRefreshDelay() is used. Otherwise the calculated refresh delay multiplied by AbstractReloadingMetadataProvider.getRefreshDelayFactor() is used. By using this factor, the provider will attempt to be refresh before the cache actually expires, allowing a some room for error and recovery. Assuming the factor is not exceedingly close to 1.0 and a min refresh delay that is not overly large, this refresh will likely occur a few times before the cache expires.

ネストされたクラスの概要

インタフェースから継承されたネストされたクラス/インタフェース org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

ObservableMetadataProvider.Observer

フィールドの概要

クラスから継承されたフィールド org.opensaml.saml2.metadata.provider.BaseMetadataProvider

unmarshallerFactory

コンストラクタの概要

コンストラクタ

コンストラクタと説明
FilesystemMetadataProvider(File metadata) Constructor.
FilesystemMetadataProvider(Timer backgroundTaskTimer, File metadata) Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	destroy() Destroys the metadata provider and frees any resources current held by it.
protected byte[]	fetchMetadata() Fetches metadata from a source.
protected String	getMetadataIdentifier() Gets an identifier which may be used to distinguish this metadata in logging statements.
boolean	maintainExpiredMetadata() 推奨されていません。 use BaseMetadataProvider.requireValidMetadata() instead
void	setMaintainExpiredMetadata(boolean maintain) 推奨されていません。 use BaseMetadataProvider.setRequireValidMetadata(boolean) instead
protected void	setMetadataFile(File file) Sets the file from which metadata is read.

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractReloadingMetadataProvider

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

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

emitChangeEvent, getObservers

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.AbstractMetadataProvider

clearDescriptorIndex, doGetEntitiesDescriptor, doGetEntityDescriptor, doGetRole, doGetRole, filterMetadata, getEntitiesDescriptor, getEntitiesDescriptorByName, getEntityDescriptor, getEntityDescriptorById, getEntityDescriptorById, getMetadata, getParserPool, getRole, getRole, initialize, isFailFastInitialization, isInitialized, isValid, releaseMetadataDOM, setFailFastInitialization, setInitialized, setParserPool, unmarshallMetadata

クラスから継承されたメソッド org.opensaml.saml2.metadata.provider.BaseMetadataProvider

getMetadataFilter, requireValidMetadata, setMetadataFilter, setRequireValidMetadata

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド org.opensaml.saml2.metadata.provider.MetadataProvider

getEntitiesDescriptor, getEntityDescriptor, getMetadata, getMetadataFilter, getRole, getRole, requireValidMetadata, setMetadataFilter, setRequireValidMetadata

コンストラクタの詳細

FilesystemMetadataProvider

public FilesystemMetadataProvider(File metadata)
                           throws MetadataProviderException

Constructor.

パラメータ:

metadata - the metadata file

例外:

MetadataProviderException - thrown if the given file path is null, does not exist, does not represent a file, or if the metadata can not be parsed

FilesystemMetadataProvider

public FilesystemMetadataProvider(Timer backgroundTaskTimer,
                          File metadata)
                           throws MetadataProviderException

Constructor.

パラメータ:

metadata - the metadata file

backgroundTaskTimer - timer used to refresh metadata in the background

例外:

MetadataProviderException - thrown if the given file path is null, does not exist, does not represent a file, or if the metadata can not be parsed

メソッドの詳細

setMetadataFile

protected void setMetadataFile(File file)
                        throws MetadataProviderException

Sets the file from which metadata is read. The given file path is checked to see if it exists, is a file, and is readable.

パラメータ:

file - path to the metadata file

例外:

MetadataProviderException - thrown if the file does not exist or is not a readable file

maintainExpiredMetadata

public boolean maintainExpiredMetadata()

推奨されていません。 use BaseMetadataProvider.requireValidMetadata() instead

Gets whether cached metadata should be discarded if it expires and can not be refreshed.

戻り値:

whether cached metadata should be discarded if it expires and can not be refreshed.

setMaintainExpiredMetadata

public void setMaintainExpiredMetadata(boolean maintain)

推奨されていません。 use BaseMetadataProvider.setRequireValidMetadata(boolean) instead

Sets whether cached metadata should be discarded if it expires and can not be refreshed.

パラメータ:

maintain - whether cached metadata should be discarded if it expires and can not be refreshed.

destroy

public void destroy()

Destroys the metadata provider and frees any resources current held by it. Default method is a no-op.

オーバーライド:

destroy クラス内 AbstractReloadingMetadataProvider

getMetadataIdentifier

protected String getMetadataIdentifier()

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

定義:

getMetadataIdentifier クラス内 AbstractReloadingMetadataProvider

戻り値:

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

fetchMetadata

protected byte[] fetchMetadata()
                        throws MetadataProviderException

Fetches metadata from a source.

定義:

fetchMetadata クラス内 AbstractReloadingMetadataProvider

戻り値:

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

例外:

MetadataProviderException - thrown if there is a problem fetching the metadata