org.opensaml.saml2.metadata.provider
Class 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.FilesystemMetadataProvider
- All Implemented Interfaces:
- MetadataProvider, ObservableMetadataProvider
public class FilesystemMetadataProvider
- extends AbstractObservableMetadataProvider
A metadata provider that pulls metadata from a file on the local filesystem. Metadata is cached and automatically
refreshed when the file changes.
It is the responsibility of the caller to re-initialize, via initialize()
, if any properties of this
provider are changed.
Method Summary |
org.opensaml.xml.XMLObject |
getMetadata()
Gets the entire metadata tree, after the registered filter has been applied. |
void |
initialize()
Initializes the provider and prepares it for use. |
boolean |
maintainExpiredMetadata()
Gets whether cached metadata should be discarded if it expires and can not be refreshed. |
void |
setMaintainExpiredMetadata(boolean maintain)
Sets whether cached metadata should be discarded if it expires and can not be refreshed. |
Methods inherited from class org.opensaml.saml2.metadata.provider.AbstractMetadataProvider |
clearDescriptorIndex, filterMetadata, getEntitiesDescriptor, getEntitiesDescriptorByName, getEntityDescriptor, getEntityDescriptorById, getEntityDescriptorById, getParserPool, getRole, getRole, isValid, releaseMetadataDOM, setParserPool, unmarshallMetadata |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FilesystemMetadataProvider
public FilesystemMetadataProvider(java.io.File metadata)
throws MetadataProviderException
- Constructor.
- Parameters:
metadata
- the metadata file
- Throws:
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
initialize
public void initialize()
throws MetadataProviderException
- Initializes the provider and prepares it for use.
- Throws:
MetadataProviderException
- thrown if there is a problem reading, parsing, or validating the metadata
maintainExpiredMetadata
public boolean maintainExpiredMetadata()
- Gets whether cached metadata should be discarded if it expires and can not be refreshed.
- Returns:
- whether cached metadata should be discarded if it expires and can not be refreshed
setMaintainExpiredMetadata
public void setMaintainExpiredMetadata(boolean maintain)
- Sets whether cached metadata should be discarded if it expires and can not be refreshed.
- Parameters:
maintain
- whether cached metadata should be discarded if it expires and can not be refreshed
getMetadata
public org.opensaml.xml.XMLObject getMetadata()
throws MetadataProviderException
- Gets the entire metadata tree, after the registered filter has been applied.
- Returns:
- the entire metadata tree
- Throws:
MetadataProviderException
- thrown if the provider can not fetch the metadata
Copyright © 2006-2009 Internet2. All Rights Reserved.