opensaml::saml2md::DiscoverableMetadataProvider Class Reference

A metadata provider that provides a JSON feed of IdP discovery information. More...

#include <saml/saml2/metadata/DiscoverableMetadataProvider.h>

Inheritance diagram for opensaml::saml2md::DiscoverableMetadataProvider:

Collaboration diagram for opensaml::saml2md::DiscoverableMetadataProvider:

List of all members.

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.
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.
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

(

)

[protected, virtual]

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]

Storage for feed.

std::string opensaml::saml2md::DiscoverableMetadataProvider::m_feedTag [mutable, protected]

ETag for feed.

---

The documentation for this class was generated from the following file:

• saml/saml2/metadata/DiscoverableMetadataProvider.h