shibsp::AttributeDecoder Class Reference

Decodes XML objects into resolved Attributes. More...

#include <shibsp/attribute/AttributeDecoder.h>

Collaboration diagram for shibsp::AttributeDecoder:

Public Member Functions
virtual Attribute *	decode (const std::vector< std::string > &ids, const xmltooling::XMLObject *xmlObject, const char *assertingParty=nullptr, const char *relyingParty=nullptr) const =0
	Decodes an XMLObject into a resolved Attribute.

Protected Member Functions
	AttributeDecoder (const xercesc::DOMElement *e)
	Constructor.
virtual Attribute *	_decode (Attribute *attr) const
	Helper method to handle base class decoding housekeeping.

Protected Attributes
bool	m_caseSensitive
	Flag for case sensitivity of decoded attributes.
bool	m_internal
	Flag for hiding attributes from CGI export.
std::string	m_hashAlg
	Hash algorithm to apply to decoded values.

Detailed Description

Decodes XML objects into resolved Attributes.

Constructor & Destructor Documentation

shibsp::AttributeDecoder::AttributeDecoder ( const xercesc::DOMElement *  e )

protected

Constructor.

Parameters

e	root of DOM to configure the decoder

Member Function Documentation

virtual Attribute* shibsp::AttributeDecoder::_decode ( Attribute *  attr ) const

protectedvirtual

Helper method to handle base class decoding housekeeping.

Parameters

attr	the new Attribute object being created

Returns

the attr parameter

virtual Attribute* shibsp::AttributeDecoder::decode ( const std::vector< std::string > &  ids, const xmltooling::XMLObject *  xmlObject, const char *  assertingParty = nullptr, const char *  relyingParty = nullptr  ) const

pure virtual

Decodes an XMLObject into a resolved Attribute.

Parameters

ids	array containing primary identifier in first position, followed by any aliases
xmlObject	XMLObject to decode
assertingParty	name of the party asserting the attribute
relyingParty	name of the party relying on the attribute

Returns

a resolved Attribute, or nullptr

Member Data Documentation

bool shibsp::AttributeDecoder::m_caseSensitive

protected

Flag for case sensitivity of decoded attributes.

std::string shibsp::AttributeDecoder::m_hashAlg

protected

Hash algorithm to apply to decoded values.

bool shibsp::AttributeDecoder::m_internal

protected

Flag for hiding attributes from CGI export.

---

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

• shibsp/attribute/AttributeDecoder.h