org.opensaml.saml2.metadata.provider
Class ResourceBackedMetadataProvider

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

All Implemented Interfaces:

MetadataProvider, ObservableMetadataProvider

public class ResourceBackedMetadataProvider
extends AbstractReloadingMetadataProvider

A metadata provider that reads metadata from a {#link Resource.

Since:

2.2

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

log

private final org.slf4j.Logger log

Class logger.

metadataResource

private Resource metadataResource

Resource from which metadata is read.

Constructor Detail

ResourceBackedMetadataProvider

public ResourceBackedMetadataProvider(Resource resource,
                                      Timer timer,
                                      long maxMetadataCacheDuration)
                               throws MetadataProviderException

Deprecated.

Constructor.

Parameters:

resource - resource from which to read the metadata file.

timer - task timer used to schedule metadata refresh tasks

maxMetadataCacheDuration - maximum amount of time, in milliseconds, that metadata may be cached before being re-read

Throws:

MetadataProviderException - thrown if there is a problem retrieving information about the resource

ResourceBackedMetadataProvider

public ResourceBackedMetadataProvider(Timer timer,
                                      Resource resource)
                               throws MetadataProviderException

Constructor.

Parameters:

resource - resource from which to read the metadata file.

timer - task timer used to schedule metadata refresh tasks

Throws:

MetadataProviderException - thrown if there is a problem retrieving information about the resource

Method Detail

maintainExpiredMetadata

public boolean maintainExpiredMetadata()

Deprecated. use BaseMetadataProvider.requireValidMetadata() instead

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)

Deprecated. use BaseMetadataProvider.setRequireValidMetadata(boolean) instead

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.

destroy

public void destroy()

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

Overrides:

destroy in class AbstractReloadingMetadataProvider

getMetadataIdentifier

protected String getMetadataIdentifier()

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

Specified by:

getMetadataIdentifier in class AbstractReloadingMetadataProvider

Returns:

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

fetchMetadata

protected byte[] fetchMetadata()
                        throws MetadataProviderException

Fetches metadata from a source.

Specified by:

fetchMetadata in class AbstractReloadingMetadataProvider

Returns:

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

Throws:

MetadataProviderException - thrown if there is a problem fetching the metadata