org.opensaml.saml2.metadata.provider
Class DOMMetadataProvider

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

All Implemented Interfaces:

MetadataProvider, ObservableMetadataProvider

public class DOMMetadataProvider
extends AbstractObservableMetadataProvider
implements MetadataProvider

A MetadataProvider implementation that retrieves metadata from a DOM Element as supplied by the user. It is the responsibility of the caller to re-initialize, via initialize(), if any properties of this provider are changed.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensaml.saml2.metadata.provider.ObservableMetadataProvider

ObservableMetadataProvider.Observer

Field Summary

Fields inherited from class org.opensaml.saml2.metadata.provider.BaseMetadataProvider

unmarshallerFactory

Constructor Summary

DOMMetadataProvider(org.w3c.dom.Element mdElement)
Constructor.

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.

Methods inherited from class org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

emitChangeEvent, getObservers

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 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, getMetadataFilter, getRole, getRole, requireValidMetadata, setMetadataFilter, setRequireValidMetadata

Constructor Detail

DOMMetadataProvider

public DOMMetadataProvider(org.w3c.dom.Element mdElement)

Constructor.

Parameters:

mdElement - the metadata element

Method Detail

getMetadata

public org.opensaml.xml.XMLObject getMetadata()

Gets the entire metadata tree, after the registered filter has been applied.

Specified by:

getMetadata in interface MetadataProvider

Returns:

the entire metadata tree

initialize

public void initialize()
                throws MetadataProviderException

Initializes the provider and prepares it for use.

Throws:

MetadataProviderException - thrown if the metadata element provided can not be read or is not valid metadata