Package se.swedenconnect.opensaml.saml2.metadata.provider

Class StaticMetadataProvider

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

se.swedenconnect.opensaml.saml2.metadata.provider.AbstractMetadataProvider

se.swedenconnect.opensaml.saml2.metadata.provider.StaticMetadataProvider

All Implemented Interfaces:

net.shibboleth.shared.component.Component, net.shibboleth.shared.component.DestructableComponent, net.shibboleth.shared.component.InitializableComponent, MetadataProvider

public class StaticMetadataProvider
extends AbstractMetadataProvider

A MetadataProvider that is given an object representing SAML metadata (EntityDescriptor or EntitiesDescriptor).

Author:

Martin Lindström (martin@idsec.se)

Nested Class Summary

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

AbstractMetadataProvider.EntityDescriptorIterator

Constructor Summary

Constructors

Constructor	Description
StaticMetadataProvider(org.opensaml.saml.saml2.metadata.EntitiesDescriptor entitiesDescriptor)	Constructor that takes an EntitiesDescriptor object.
StaticMetadataProvider(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor)	Constructor that takes an {link EntityDescriptor} object.
StaticMetadataProvider(Element element)	Constructor that takes a DOM element representing the metadata.

Method Summary

Modifier and Type	Method	Description
protected void	createMetadataResolver(boolean requireValidMetadata, boolean failFastInitialization, org.opensaml.saml.metadata.resolver.filter.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.
org.opensaml.saml.metadata.resolver.MetadataResolver	getMetadataResolver()	Returns the underlying OpenSAML metadata resolver.
protected void	initializeMetadataResolver()	Initializes the metadata resolver.
void	setID(String id)	Assigns the ID for the provider.

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

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

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Constructor Details

StaticMetadataProvider

public StaticMetadataProvider(Element element)

Constructor that takes a DOM element representing the metadata.

Parameters:

element - DOM element

StaticMetadataProvider

public StaticMetadataProvider(org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor)
                       throws org.opensaml.core.xml.io.MarshallingException

Constructor that takes an {link EntityDescriptor} object.

Parameters:

entityDescriptor - the metadata EntityDescriptor

Throws:

org.opensaml.core.xml.io.MarshallingException - if the supplied object cannot be marshalled

StaticMetadataProvider

public StaticMetadataProvider(org.opensaml.saml.saml2.metadata.EntitiesDescriptor entitiesDescriptor)
                       throws org.opensaml.core.xml.io.MarshallingException

Constructor that takes an EntitiesDescriptor object.

Parameters:

entitiesDescriptor - the metadata EntitiesDescriptor

Throws:

org.opensaml.core.xml.io.MarshallingException - if the supplied object cannot be marshalled

Method Details

getID

public String getID()

Returns the identifier for the provider.

Returns:

the identifier

setID

public void setID(String id)

Assigns the ID for the provider.

Parameters:

id - the ID

getMetadataResolver

public org.opensaml.saml.metadata.resolver.MetadataResolver getMetadataResolver()

Returns the underlying OpenSAML metadata resolver.

Returns:

OpenSAML metadata resolver

createMetadataResolver

protected void createMetadataResolver(boolean requireValidMetadata,
 boolean failFastInitialization,
 org.opensaml.saml.metadata.resolver.filter.MetadataFilter filter)

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

initializeMetadataResolver

protected void initializeMetadataResolver()
                                   throws net.shibboleth.shared.component.ComponentInitializationException

Initializes the metadata resolver.

Specified by:

initializeMetadataResolver in class AbstractMetadataProvider

Throws:

net.shibboleth.shared.component.ComponentInitializationException - for initialization errors

destroyMetadataResolver

protected void destroyMetadataResolver()

Destroys the metadata resolver.

Specified by:

destroyMetadataResolver in class AbstractMetadataProvider