|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.ResourceBackedMetadataProvider
public class ResourceBackedMetadataProvider
A metadata provider that reads metadata from a {#link Resource
.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.opensaml.saml2.metadata.provider.ObservableMetadataProvider |
---|
ObservableMetadataProvider.Observer |
Field Summary | |
---|---|
private org.slf4j.Logger |
log
Class logger. |
private Resource |
metadataResource
Resource from which metadata is read. |
Fields inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
unmarshallerFactory |
Constructor Summary | |
---|---|
ResourceBackedMetadataProvider(Resource resource,
Timer timer,
long maxMetadataCacheDuration)
Deprecated. |
|
ResourceBackedMetadataProvider(Timer timer,
Resource resource)
Constructor. |
Method Summary | |
---|---|
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()
Deprecated. use BaseMetadataProvider.requireValidMetadata() instead |
void |
setMaintainExpiredMetadata(boolean maintain)
Deprecated. use BaseMetadataProvider.setRequireValidMetadata(boolean) instead |
Methods inherited from class 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 |
Methods inherited from class org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider |
---|
emitChangeEvent, getObservers |
Methods inherited from class 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 |
Methods inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider |
---|
getMetadataFilter, requireValidMetadata, setMetadataFilter, setRequireValidMetadata |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.opensaml.saml2.metadata.provider.MetadataProvider |
---|
getEntitiesDescriptor, getEntityDescriptor, getMetadata, getMetadataFilter, getRole, getRole, requireValidMetadata, setMetadataFilter, setRequireValidMetadata |
Field Detail |
---|
private final org.slf4j.Logger log
private Resource metadataResource
Constructor Detail |
---|
public ResourceBackedMetadataProvider(Resource resource, Timer timer, long maxMetadataCacheDuration) throws MetadataProviderException
resource
- resource from which to read the metadata file.timer
- task timer used to schedule metadata refresh tasksmaxMetadataCacheDuration
- maximum amount of time, in milliseconds, that metadata may be cached before being
re-read
MetadataProviderException
- thrown if there is a problem retrieving information about the resourcepublic ResourceBackedMetadataProvider(Timer timer, Resource resource) throws MetadataProviderException
resource
- resource from which to read the metadata file.timer
- task timer used to schedule metadata refresh tasks
MetadataProviderException
- thrown if there is a problem retrieving information about the resourceMethod Detail |
---|
public boolean maintainExpiredMetadata()
BaseMetadataProvider.requireValidMetadata()
instead
public void setMaintainExpiredMetadata(boolean maintain)
BaseMetadataProvider.setRequireValidMetadata(boolean)
instead
maintain
- whether cached metadata should be discarded if it expires and can not be refreshed.public void destroy()
destroy
in class AbstractReloadingMetadataProvider
protected String getMetadataIdentifier()
getMetadataIdentifier
in class AbstractReloadingMetadataProvider
protected byte[] fetchMetadata() throws MetadataProviderException
fetchMetadata
in class AbstractReloadingMetadataProvider
MetadataProviderException
- thrown if there is a problem fetching the metadata
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |