OpenSAML-J 2.4.1-redhat-3

org.opensaml.saml2.metadata.provider
Class DOMMetadataProvider

java.lang.Object
  extended by org.opensaml.saml2.metadata.provider.BaseMetadataProvider
      extended by org.opensaml.saml2.metadata.provider.AbstractMetadataProvider
          extended by org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider
              extended by 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 AbstractMetadataProvider.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(Element mdElement)
          Constructor.
 
Method Summary
protected  org.opensaml.xml.XMLObject doGetMetadata()
          Gets the metadata currently held by the provider.
protected  void doInitialization()
          Subclasses should override this method to perform any initialization logic necessary.
 
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
 

Constructor Detail

DOMMetadataProvider

public DOMMetadataProvider(Element mdElement)
Constructor.

Parameters:
mdElement - the metadata element
Method Detail

doGetMetadata

protected org.opensaml.xml.XMLObject doGetMetadata()
                                            throws MetadataProviderException
Gets the metadata currently held by the provider. This method should not check if the provider is initialized, if the metadata is valid, etc. All of this is done by the invoker of this method.

Specified by:
doGetMetadata in class AbstractMetadataProvider
Returns:
the metadata currently held by this provider or null if no metadata is available
Throws:
MetadataProviderException - thrown if there is a problem retrieving the metadata

doInitialization

protected void doInitialization()
                         throws MetadataProviderException
Subclasses should override this method to perform any initialization logic necessary. Default implementation is a no-op.

Overrides:
doInitialization in class AbstractMetadataProvider
Throws:
MetadataProviderException - thrown if there is a problem initializing the provider

OpenSAML-J 2.4.1-redhat-3

Copyright © 2006-2012 Internet2. All Rights Reserved.