opensaml-3.2.1
opensaml::saml2md::ObservableMetadataProvider Class Reference

A metadata provider that notifies interested parties of changes. More...

#include <saml/saml2/metadata/ObservableMetadataProvider.h>

Inheritance diagram for opensaml::saml2md::ObservableMetadataProvider:
opensaml::saml2md::MetadataProvider opensaml::saml2md::AbstractMetadataProvider opensaml::saml2md::AbstractDynamicMetadataProvider

Classes

class  Observer
 An observer of metadata provider changes. More...
 

Public Member Functions

virtual void addObserver (const Observer *newObserver) const
 Adds a metadata observer. More...
 
virtual const ObserverremoveObserver (const Observer *oldObserver) const
 Removes a metadata observer. More...
 
- Public Member Functions inherited from opensaml::saml2md::MetadataProvider
virtual ~MetadataProvider ()
 Destructor will delete any installed filters.
 
virtual const char * getId () const
 Returns an identifier for the provider for logging/status purposes. More...
 
virtual void addMetadataFilter (MetadataFilter *newFilter)
 Adds a metadata filter to apply to any resolved metadata. More...
 
virtual MetadataFilterremoveMetadataFilter (MetadataFilter *oldFilter)
 Removes a metadata filter. More...
 
void setContext (const MetadataFilterContext *ctx)
 Sets a filtering context object for use by the filtering process. More...
 
virtual void init ()=0
 Should be called after instantiating provider and adding filters, but before performing any lookup operations. More...
 
virtual void outputStatus (std::ostream &os) const
 Generate an XML representation of the provider's status. More...
 
virtual const xmltooling::XMLObject * getMetadata () const =0
 Gets the entire metadata tree, after the registered filter has been applied. More...
 
virtual const EntitiesDescriptor * getEntitiesDescriptor (const XMLCh *name, bool requireValidMetadata=true) const
 Gets the metadata for a given group of entities. More...
 
virtual const EntitiesDescriptor * getEntitiesDescriptor (const char *name, bool requireValidMetadata=true) const =0
 Gets the metadata for a given group of entities. More...
 
virtual std::pair< const EntityDescriptor *, const RoleDescriptor * > getEntityDescriptor (const Criteria &criteria) const =0
 Gets entity metadata based on supplied criteria. More...
 

Protected Member Functions

 ObservableMetadataProvider (const xercesc::DOMElement *e=0, bool deprecationSupport=true)
 Constructor. More...
 
virtual void emitChangeEvent () const
 Convenience method for notifying every registered Observer of an event.
 
virtual void emitChangeEvent (const EntityDescriptor &entity) const
 Convenience method for notifying every registered Observer of an event.
 
- Protected Member Functions inherited from opensaml::saml2md::MetadataProvider
 MetadataProvider (const xercesc::DOMElement *e, bool deprecationSupport=true)
 Constructor. More...
 
void doFilters (const MetadataFilterContext *ctx, xmltooling::XMLObject &xmlObject) const
 Applies any installed filters to a metadata instance. More...
 

Detailed Description

A metadata provider that notifies interested parties of changes.

Constructor & Destructor Documentation

◆ ObservableMetadataProvider()

opensaml::saml2md::ObservableMetadataProvider::ObservableMetadataProvider ( const xercesc::DOMElement *  e = 0,
bool  deprecationSupport = true 
)
protected

Constructor.

Parameters
eDOM to supply configuration for provider
deprecationSupporttrue iff deprecated features and settings should be supported

Member Function Documentation

◆ addObserver()

virtual void opensaml::saml2md::ObservableMetadataProvider::addObserver ( const Observer newObserver) const
virtual

Adds a metadata observer.

Parameters
newObservermetadata observer to add

◆ removeObserver()

virtual const Observer* opensaml::saml2md::ObservableMetadataProvider::removeObserver ( const Observer oldObserver) const
virtual

Removes a metadata observer.

Parameters
oldObservermetadata observer to remove
Returns
the old observer

The documentation for this class was generated from the following file: