opensaml::saml2md::DynamicMetadataProvider Class Reference

Simple implementation of a dynamic, caching MetadataProvider. More...

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

Inheritance diagram for opensaml::saml2md::DynamicMetadataProvider:

opensaml::saml2md::AbstractMetadataProvider opensaml::saml2md::ObservableMetadataProvider opensaml::saml2md::MetadataProvider

List of all members.

Public Member Functions

 DynamicMetadataProvider (const xercesc::DOMElement *e=nullptr)
 Constructor.
void init ()
 Should be called after instantiating provider and adding filters, but before performing any lookup operations.
xmltooling::Lockable * lock ()
void unlock ()
const char * getId () const
 Returns an identifier for the provider for logging/status purposes.
const xmltooling::XMLObject * getMetadata () const
 Gets the entire metadata tree, after the registered filter has been applied.
std::pair< const
EntityDescriptor *, const
RoleDescriptor * > 
getEntityDescriptor (const Criteria &criteria) const
 Gets entity metadata based on supplied criteria.

Protected Member Functions

virtual EntityDescriptor * resolve (const Criteria &criteria) const
 Resolves a metadata instance using the supplied criteria.

Protected Attributes

bool m_validate
 Controls XML schema validation.


Detailed Description

Simple implementation of a dynamic, caching MetadataProvider.

Constructor & Destructor Documentation

opensaml::saml2md::DynamicMetadataProvider::DynamicMetadataProvider ( const xercesc::DOMElement *  e = nullptr  ) 

Constructor.

Parameters:
e DOM to supply configuration for provider


Member Function Documentation

void opensaml::saml2md::DynamicMetadataProvider::init (  )  [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.

const char* opensaml::saml2md::DynamicMetadataProvider::getId (  )  const [virtual]

Returns an identifier for the provider for logging/status purposes.

Returns:
an identifier, or null

Reimplemented from opensaml::saml2md::MetadataProvider.

const xmltooling::XMLObject* opensaml::saml2md::DynamicMetadataProvider::getMetadata (  )  const [virtual]

Gets the entire metadata tree, after the registered filter has been applied.

The caller MUST unlock the provider when finished with the data.

Returns:
the entire metadata tree

Implements opensaml::saml2md::MetadataProvider.

std::pair<const EntityDescriptor*,const RoleDescriptor*> opensaml::saml2md::DynamicMetadataProvider::getEntityDescriptor ( const Criteria criteria  )  const [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.

Parameters:
criteria lookup criteria
Returns:
the entity's metadata (and optionally a role) or nullptr if there is no qualifying metadata

Reimplemented from opensaml::saml2md::AbstractMetadataProvider.

virtual EntityDescriptor* opensaml::saml2md::DynamicMetadataProvider::resolve ( const Criteria criteria  )  const [protected, virtual]

Resolves a metadata instance using the supplied criteria.

Parameters:
criteria lookup criteria
Returns:
a valid metadata instance


Member Data Documentation

Controls XML schema validation.


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

Generated on Mon Dec 10 19:28:30 2012 for opensaml-2.5.1 by  doxygen 1.5.6