org.opensaml.saml2.metadata.provider
Class AbstractObservableMetadataProvider

java.lang.Object
  org.opensaml.saml2.metadata.provider.BaseMetadataProvider
      org.opensaml.saml2.metadata.provider.AbstractMetadataProvider
          org.opensaml.saml2.metadata.provider.AbstractObservableMetadataProvider

All Implemented Interfaces:

MetadataProvider, ObservableMetadataProvider

Direct Known Subclasses:

AbstractReloadingMetadataProvider, DOMMetadataProvider

public abstract class AbstractObservableMetadataProvider
extends AbstractMetadataProvider
implements ObservableMetadataProvider

An observable base implementation of metadata providers. An observer that clears the descriptor index kept by AbstractMetadataProvider is registered during construction time.

Nested Class Summary

private class

AbstractObservableMetadataProvider.DescriptorIndexClearingObserver Observer that clears the descriptor index of this provider.

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

ObservableMetadataProvider.Observer

Field Summary

private List<ObservableMetadataProvider.Observer>

observers List of registered observers.

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

unmarshallerFactory

Constructor Summary

AbstractObservableMetadataProvider()
Constructor.

Method Summary

void	destroy() Destroys the metadata provider and frees any resources current held by it.
protected void	emitChangeEvent() Helper method for calling ObservableMetadataProvider.Observer.onEvent(MetadataProvider) on every registered Observer passing in this provider.
List<ObservableMetadataProvider.Observer>	getObservers() Gets the list of observers for the provider.

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

clearDescriptorIndex, doGetEntitiesDescriptor, doGetEntityDescriptor, doGetMetadata, doGetRole, doGetRole, doInitialization, 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

observers

private List<ObservableMetadataProvider.Observer> observers

List of registered observers.

Constructor Detail

AbstractObservableMetadataProvider

public AbstractObservableMetadataProvider()

Constructor.

Method Detail

getObservers

public List<ObservableMetadataProvider.Observer> getObservers()

Gets the list of observers for the provider. New observers may be added to the list or old ones removed.

Specified by:

getObservers in interface ObservableMetadataProvider

Returns:

the list of observers

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 AbstractMetadataProvider

emitChangeEvent

protected void emitChangeEvent()

Helper method for calling ObservableMetadataProvider.Observer.onEvent(MetadataProvider) on every registered Observer passing in this provider.