opensaml-2.4.3
|
Simple implementation of a dynamic, caching MetadataProvider. More...
#include <saml/saml2/metadata/DynamicMetadataProvider.h>
Public Member Functions | |
DynamicMetadataProvider (const xercesc::DOMElement *e=nullptr) | |
Constructor. More... | |
void | init () |
Should be called after instantiating provider and adding filters, but before performing any lookup operations. More... | |
xmltooling::Lockable * | lock () |
void | unlock () |
const xmltooling::XMLObject * | getMetadata () const |
Gets the entire metadata tree, after the registered filter has been applied. More... | |
std::pair< const EntityDescriptor *, const RoleDescriptor * > | getEntityDescriptor (const Criteria &criteria) const |
Gets entity metadata based on supplied criteria. More... | |
![]() | |
void | emitChangeEvent () const |
Convenience method for notifying every registered Observer of an event. | |
const EntitiesDescriptor * | getEntitiesDescriptor (const char *name, bool requireValidMetadata=true) const |
Gets the metadata for a given group of entities. More... | |
const xmltooling::Credential * | resolve (const xmltooling::CredentialCriteria *criteria=nullptr) const |
std::vector< const xmltooling::Credential * > ::size_type | resolve (std::vector< const xmltooling::Credential * > &results, const xmltooling::CredentialCriteria *criteria=nullptr) const |
![]() | |
virtual void | addObserver (const Observer *newObserver) const |
Adds a metadata observer. More... | |
virtual const Observer * | removeObserver (const Observer *oldObserver) const |
Removes a metadata observer. More... | |
![]() | |
virtual | ~MetadataProvider () |
Destructor will delete any installed filters. | |
virtual void | addMetadataFilter (MetadataFilter *newFilter) |
Adds a metadata filter to apply to any resolved metadata. More... | |
virtual MetadataFilter * | removeMetadataFilter (MetadataFilter *oldFilter) |
Removes a metadata filter. More... | |
virtual const EntitiesDescriptor * | getEntitiesDescriptor (const XMLCh *name, bool requireValidMetadata=true) const |
Gets the metadata for a given group of entities. More... | |
Protected Member Functions | |
virtual EntityDescriptor * | resolve (const Criteria &criteria) const |
Resolves a metadata instance using the supplied criteria. More... | |
![]() | |
AbstractMetadataProvider (const xercesc::DOMElement *e=nullptr) | |
Constructor. More... | |
virtual void | indexEntity (EntityDescriptor *site, time_t &validUntil, bool replace=false) const |
Loads an entity into the cache for faster lookup. More... | |
virtual void | indexGroup (EntitiesDescriptor *group, time_t &validUntil) const |
Loads a group of entities into the cache for faster lookup. More... | |
virtual void | index (EntityDescriptor *site, time_t validUntil, bool replace=false) const |
virtual void | index (EntitiesDescriptor *group, time_t validUntil) const |
virtual void | clearDescriptorIndex (bool freeSites=false) |
Clear the cache of known entities and groups. More... | |
![]() | |
ObservableMetadataProvider (const xercesc::DOMElement *e=nullptr) | |
Constructor. More... | |
![]() | |
MetadataProvider (const xercesc::DOMElement *e=nullptr) | |
Constructor. More... | |
void | doFilters (xmltooling::XMLObject &xmlObject) const |
Applies any installed filters to a metadata instance. More... | |
Protected Attributes | |
bool | m_validate |
Controls XML schema validation. More... | |
![]() | |
xmltooling::KeyInfoResolver * | m_resolver |
Embedded KeyInfoResolver instance. More... | |
Simple implementation of a dynamic, caching MetadataProvider.
opensaml::saml2md::DynamicMetadataProvider::DynamicMetadataProvider | ( | const xercesc::DOMElement * | e = nullptr | ) |
Constructor.
e | DOM to supply configuration for provider |
|
virtual |
Gets entity metadata based on supplied criteria.
If a valid entity is returned, the provider will be left in a locked state. The caller MUST unlock the provider when finished with the entity.
criteria | lookup criteria |
Reimplemented from opensaml::saml2md::AbstractMetadataProvider.
|
virtual |
Gets the entire metadata tree, after the registered filter has been applied.
The caller MUST unlock the provider when finished with the data.
Implements opensaml::saml2md::MetadataProvider.
|
virtual |
Should be called after instantiating provider and adding filters, but before performing any lookup operations.
Allows the provider to defer initialization processes that are likely to result in exceptions until after the provider is safely created. Providers SHOULD perform as much processing as possible in this method so as to report/log any errors that would affect later processing.
Implements opensaml::saml2md::MetadataProvider.
|
protectedvirtual |
Resolves a metadata instance using the supplied criteria.
criteria | lookup criteria |
|
protected |
Controls XML schema validation.