A metadata provider that provides a JSON feed of IdP discovery information.
More...
#include <saml/saml2/metadata/DiscoverableMetadataProvider.h>
Public Member Functions |
virtual std::string | getCacheTag () const |
| Returns the ETag associated with the cached feed.
|
virtual void | outputFeed (std::ostream &os, bool &first, bool wrapArray=true) const |
| Outputs the cached feed.
|
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 |
| DiscoverableMetadataProvider (const xercesc::DOMElement *e=nullptr) |
| Constructor.
|
virtual void | generateFeed () |
| Generates a JSON feed of IdP discovery information for the current metadata.
|
| MetadataProvider (const xercesc::DOMElement *e=nullptr) |
| Constructor.
|
void | doFilters (xmltooling::XMLObject &xmlObject) const |
| Applies any installed filters to a metadata instance.
|
Protected Attributes |
std::string | m_feed |
| Storage for feed.
|
std::string | m_feedTag |
| ETag for feed.
|
Detailed Description
A metadata provider that provides a JSON feed of IdP discovery information.
Constructor & Destructor Documentation
opensaml::saml2md::DiscoverableMetadataProvider::DiscoverableMetadataProvider |
( |
const xercesc::DOMElement * |
e = nullptr | ) |
|
|
protected |
Constructor.
If a DOM is supplied, the following XML content is supported:
- legacyOrgNames
- true iff IdPs without a UIInfo extension should be identified using <md:OrganizationDisplayName>
- Parameters
-
e | DOM to supply configuration for provider |
Member Function Documentation
virtual void opensaml::saml2md::DiscoverableMetadataProvider::generateFeed |
( |
| ) |
|
|
protectedvirtual |
Generates a JSON feed of IdP discovery information for the current metadata.
The provider MUST be write-locked.
virtual std::string opensaml::saml2md::DiscoverableMetadataProvider::getCacheTag |
( |
| ) |
const |
|
virtual |
Returns the ETag associated with the cached feed.
The provider MUST be locked.
- Returns
- the ETag value for the current feed state
virtual void opensaml::saml2md::DiscoverableMetadataProvider::outputFeed |
( |
std::ostream & |
os, |
|
|
bool & |
first, |
|
|
bool |
wrapArray = true |
|
) |
| const |
|
virtual |
Outputs the cached feed.
The provider MUST be locked.
- Parameters
-
os | stream to output feed into |
first | on input, indicates if the feed is first in position, on output will be false if the feed was non-empty |
wrapArray | true iff the feed array should be opened/closed by this provider |
Member Data Documentation
std::string opensaml::saml2md::DiscoverableMetadataProvider::m_feed |
|
protected |
std::string opensaml::saml2md::DiscoverableMetadataProvider::m_feedTag |
|
mutableprotected |
The documentation for this class was generated from the following file: