A metadata provider that notifies interested parties of changes.
More...
#include <saml/saml2/metadata/ObservableMetadataProvider.h>
Public Member Functions |
virtual void | addObserver (const Observer *newObserver) const |
| Adds a metadata observer.
|
virtual const Observer * | removeObserver (const Observer *oldObserver) const |
| Removes a metadata observer.
|
virtual | ~MetadataProvider () |
| Destructor will delete any installed filters.
|
virtual const char * | getId () const |
| Returns an identifier for the provider for logging/status purposes.
|
virtual void | addMetadataFilter (MetadataFilter *newFilter) |
| Adds a metadata filter to apply to any resolved metadata.
|
virtual MetadataFilter * | removeMetadataFilter (MetadataFilter *oldFilter) |
| Removes a metadata filter.
|
void | setContext (const MetadataFilterContext *ctx) |
| Sets a filtering context object for use by the filtering process.
|
virtual void | init ()=0 |
| Should be called after instantiating provider and adding filters, but before performing any lookup operations.
|
virtual void | outputStatus (std::ostream &os) const |
| Generate an XML representation of the provider's status.
|
virtual const
xmltooling::XMLObject * | getMetadata () const =0 |
| Gets the entire metadata tree, after the registered filter has been applied.
|
virtual const EntitiesDescriptor * | getEntitiesDescriptor (const XMLCh *name, bool requireValidMetadata=true) const |
| Gets the metadata for a given group of entities.
|
virtual const EntitiesDescriptor * | getEntitiesDescriptor (const char *name, bool requireValidMetadata=true) const =0 |
| Gets the metadata for a given group of entities.
|
virtual std::pair< const
EntityDescriptor *, const
RoleDescriptor * > | getEntityDescriptor (const Criteria &criteria) const =0 |
| Gets entity metadata based on supplied criteria.
|
Protected Member Functions |
| ObservableMetadataProvider (const xercesc::DOMElement *e=nullptr) |
| Constructor.
|
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.
|
| MetadataProvider (const xercesc::DOMElement *e=nullptr) |
| Constructor.
|
void | doFilters (xmltooling::XMLObject &xmlObject) const |
| Applies any installed filters to a metadata instance.
|
Detailed Description
A metadata provider that notifies interested parties of changes.
Constructor & Destructor Documentation
opensaml::saml2md::ObservableMetadataProvider::ObservableMetadataProvider |
( |
const xercesc::DOMElement * |
e = nullptr | ) |
|
|
protected |
Constructor.
- Parameters
-
e | DOM to supply configuration for provider |
Member Function Documentation
virtual void opensaml::saml2md::ObservableMetadataProvider::addObserver |
( |
const Observer * |
newObserver | ) |
const |
|
virtual |
Adds a metadata observer.
- Parameters
-
newObserver | metadata observer to add |
virtual const Observer* opensaml::saml2md::ObservableMetadataProvider::removeObserver |
( |
const Observer * |
oldObserver | ) |
const |
|
virtual |
Removes a metadata observer.
- Parameters
-
oldObserver | metadata observer to remove |
- Returns
- the old observer
The documentation for this class was generated from the following file: