Package se.litsec.opensaml.saml2.metadata.provider

Class FilesystemMetadataProvider

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

se.litsec.opensaml.saml2.metadata.provider.FilesystemMetadataProvider

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MetadataProvider

public class FilesystemMetadataProvider
extends AbstractMetadataProvider

A metadata provider that reads its metadata from a file.

Author:

Martin Lindström (martin.lindstrom@litsec.se)

See Also:

FilesystemMetadataResolver

Nested Class Summary

Nested classes/interfaces inherited from class se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

AbstractMetadataProvider.EntityDescriptorIterator

Constructor Summary

Constructors

Constructor	Description
FilesystemMetadataProvider(File metadataFile)	Constructor assigning the file holding the metadata.

Method Summary

Modifier and Type	Method	Description
protected void	createMetadataResolver(boolean requireValidMetadata, boolean failFastInitialization, MetadataFilter filter)	Creates the specific MetadataResolver instance for the provider implementation.
protected void	destroyMetadataResolver()	Destroys the metadata resolver.
String	getID()	Returns the identifier for the provider.
MetadataResolver	getMetadataResolver()	Returns the underlying OpenSAML metadata resolver.
protected void	initializeMetadataResolver()	Initializes the metadata resolver.

Methods inherited from class se.litsec.opensaml.saml2.metadata.provider.AbstractMetadataProvider

createFilter, doDestroy, doInitialize, getEntityDescriptor, getIdentityProviders, getIDPSSODescriptor, getLastUpdate, getMetadata, getMetadataDOM, getServiceProviders, getSignatureVerificationCertificates, getSPSSODescriptor, iterator, iterator, refresh, setExclusionPredicates, setFailFastInitialization, setInclusionPredicates, setPerformSchemaValidation, setRequireValidMetadata, setSignatureVerificationCertificate, setSignatureVerificationCertificates

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.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Constructor Detail

FilesystemMetadataProvider

public FilesystemMetadataProvider(File metadataFile)

Constructor assigning the file holding the metadata.

Parameters:

metadataFile - metadata source

Method Detail

getID

public String getID()

Returns the identifier for the provider.

Returns:

the identifier

getMetadataResolver

public MetadataResolver getMetadataResolver()

Returns the underlying OpenSAML metadata resolver.

Returns:

OpenSAML metadata resolver

createMetadataResolver

protected void createMetadataResolver(boolean requireValidMetadata,
                                      boolean failFastInitialization,
                                      MetadataFilter filter)
                               throws ResolverException

Creates the specific MetadataResolver instance for the provider implementation.

The filter parameter is a MetadataFilter that must be installed for the resolver. Any other filters that should be installed by the specific instance should be placed last in a filter chain.

Specified by:

createMetadataResolver in class AbstractMetadataProvider

Parameters:

requireValidMetadata - should be passed into MetadataResolver.setRequireValidMetadata(boolean)

failFastInitialization - should be passed into AbstractMetadataResolver.setFailFastInitialization(boolean) (if applicable)

filter - filter that must be installed for the resolver

Throws:

ResolverException - for errors creating the resolver

initializeMetadataResolver

protected void initializeMetadataResolver()
                                   throws ComponentInitializationException

Initializes the metadata resolver.

Specified by:

initializeMetadataResolver in class AbstractMetadataProvider

Throws:

ComponentInitializationException - for initialization errors

destroyMetadataResolver

protected void destroyMetadataResolver()

Destroys the metadata resolver.

Specified by:

destroyMetadataResolver in class AbstractMetadataProvider