shibsp::AttributeExtractor Class Reference

A service that extracts and decodes attributes from XML objects. More...

#include <shibsp/attribute/resolver/AttributeExtractor.h>

List of all members.

Public Member Functions

virtual void extractAttributes (const Application &application, const opensaml::saml2md::RoleDescriptor *issuer, const xmltooling::XMLObject &xmlObject, std::vector< Attribute * > &attributes) const =0
 Extracts the attributes found in an XMLObject.
virtual void getAttributeIds (std::vector< std::string > &attributes) const =0
 Populates an array with the set of Attribute IDs that might be generated.
virtual void generateMetadata (opensaml::saml2md::SPSSODescriptor &role) const
 Generates and/or modifies metadata reflecting the extractor, typically attribute-related requirements.


Detailed Description

A service that extracts and decodes attributes from XML objects.

Member Function Documentation

virtual void shibsp::AttributeExtractor::extractAttributes ( const Application application,
const opensaml::saml2md::RoleDescriptor *  issuer,
const xmltooling::XMLObject &  xmlObject,
std::vector< Attribute * > &  attributes 
) const [pure virtual]

Extracts the attributes found in an XMLObject.

Parameters:
application Application performing the extraction
issuer source of object, if known
xmlObject object to extract
attributes an array to populate with the extracted attributes
Exceptions:
AttributeExtractionException thrown if there is a problem extracting attributes

virtual void shibsp::AttributeExtractor::getAttributeIds ( std::vector< std::string > &  attributes  )  const [pure virtual]

Populates an array with the set of Attribute IDs that might be generated.

Parameters:
attributes array to populate

virtual void shibsp::AttributeExtractor::generateMetadata ( opensaml::saml2md::SPSSODescriptor &  role  )  const [virtual]

Generates and/or modifies metadata reflecting the extractor, typically attribute-related requirements.

The default implementation does nothing.

Parameters:
role metadata role to decorate


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

Generated on Tue Jul 26 01:11:32 2011 for shibboleth-2.4.3 by  doxygen 1.5.6