|
opensaml-2.5.5
|
Base class for caching metadata providers. More...
#include <saml/saml2/metadata/AbstractMetadataProvider.h>
Public Member Functions | |
| void | outputStatus (std::ostream &os) const |
| Generate an XML representation of the provider's status. More... | |
| void | emitChangeEvent () const |
| Convenience method for notifying every registered Observer of an event. | |
| void | emitChangeEvent (const EntityDescriptor &) const |
| Convenience method for notifying every registered Observer of an event. | |
| std::pair< const EntityDescriptor *, const RoleDescriptor * > | getEntityDescriptor (const Criteria &criteria) const |
| Gets entity metadata based on supplied criteria. More... | |
| 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 |
Public Member Functions inherited from opensaml::saml2md::ObservableMetadataProvider | |
| 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... | |
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 MetadataFilter * | removeMetadataFilter (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 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... | |
Protected Member Functions | |
| 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... | |
Protected Member Functions inherited from opensaml::saml2md::ObservableMetadataProvider | |
| ObservableMetadataProvider (const xercesc::DOMElement *e=nullptr) | |
| Constructor. More... | |
Protected Member Functions inherited from opensaml::saml2md::MetadataProvider | |
| 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 | |
| time_t | m_lastUpdate |
| Time of last update for reporting. More... | |
| xmltooling::KeyInfoResolver * | m_resolver |
| Embedded KeyInfoResolver instance. More... | |
Base class for caching metadata providers.
|
protected |
Constructor.
If a DOM is supplied, a set of default logic will be used to identify and build a KeyInfoResolver plugin and install it into the provider.
The following XML content is supported:
XML namespaces are ignored in the processing of these elements.
| e | DOM to supply configuration for provider |
|
protectedvirtual |
Clear the cache of known entities and groups.
| freeSites | true iff the objects cached in the site map should be freed. |
|
virtual |
Gets the metadata for a given group of entities.
If a valid group is returned, the resolver will be left in a locked state. The caller MUST unlock the resolver when finished with the group.
| name | the name of the group |
| requireValidMetadata | indicates whether the metadata for the group must be valid/current |
Implements opensaml::saml2md::MetadataProvider.
|
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 |
Implements opensaml::saml2md::MetadataProvider.
Reimplemented in opensaml::saml2md::DynamicMetadataProvider.
|
protectedvirtual |
This includes processing known reverse lookup strategies for artifacts.
| site | entity definition |
| validUntil | maximum expiration time of the entity definition |
| replace | true iff existing entries for the same entity should be cleared/replaced |
|
protectedvirtual |
| group | group definition |
| validUntil | maximum expiration time of the group definition |
|
protectedvirtual |
Loads an entity into the cache for faster lookup.
This includes processing known reverse lookup strategies for artifacts. The validUntil parameter will contain the smallest value found on output.
| site | entity definition |
| validUntil | maximum expiration time of the entity definition |
| replace | true iff existing entries for the same entity should be cleared/replaced |
|
protectedvirtual |
Loads a group of entities into the cache for faster lookup.
The validUntil parameter will contain the smallest value found on output.
| group | group definition |
| validUntil | maximum expiration time of the group definition |
|
virtual |
Generate an XML representation of the provider's status.
The XML must be well-formed, but is otherwise arbitrary.
| os | stream to write status information to |
Reimplemented from opensaml::saml2md::MetadataProvider.
|
mutableprotected |
Time of last update for reporting.
|
protected |
Embedded KeyInfoResolver instance.