#include <saml/saml2/metadata/MetadataProvider.h>
Inheritance diagram for opensaml::saml2md::MetadataProvider:
Public Member Functions | |
virtual | ~MetadataProvider () |
Destructor will delete any installed filters. | |
virtual void | addMetadataFilter (MetadataFilter *newFilter) |
Adds a metadata filter to apply to any resolved metadata. | |
virtual MetadataFilter * | removeMetadataFilter (MetadataFilter *oldFilter) |
Removes a metadata filter. | |
virtual void | init ()=0 |
Should be called after instantiating provider and adding filters, but before performing any lookup operations. | |
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 | |
MetadataProvider (const xercesc::DOMElement *e=NULL) | |
Constructor. | |
void | doFilters (xmltooling::XMLObject &xmlObject) const |
Applies any installed filters to a metadata instance. | |
Classes | |
struct | Criteria |
Batches up criteria for entity lookup. More... |
The source can be a local file, remote service, or the result of a dynamic lookup, can include local caching, etc. Providers MUST be locked before any lookup operations.
|
Constructor. If a DOM is supplied, a set of default logic will be used to identify and build MetadataFilter plugins and install them into the provider. The following XML content is supported:
XML namespaces are ignored in the processing of these elements.
|
|
Adds a metadata filter to apply to any resolved metadata. Will not be applied to metadata that is already loaded.
|
|
Applies any installed filters to a metadata instance.
|
|
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.
Implemented in opensaml::saml2md::AbstractMetadataProvider. |
|
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.
|
|
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.
|
|
Gets the entire metadata tree, after the registered filter has been applied. The caller MUST unlock the provider when finished with the data.
Implemented in opensaml::saml2md::DynamicMetadataProvider. |
|
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. Implemented in opensaml::saml2md::DynamicMetadataProvider. |
|
Removes a metadata filter. The caller must delete the filter if necessary.
|