shibboleth-2.6.1
shibsp::AttributeDecoder Class Reference

Decodes XML objects into resolved Attributes. More...

#include <shibsp/attribute/AttributeDecoder.h>

Public Member Functions

virtual Attributedecode (const xmltooling::GenericRequest *request, const std::vector< std::string > &ids, const xmltooling::XMLObject *xmlObject, const char *assertingParty=nullptr, const char *relyingParty=nullptr) const
 Decodes an XMLObject into a resolved Attribute. More...
 
virtual Attributedecode (const std::vector< std::string > &ids, const xmltooling::XMLObject *xmlObject, const char *assertingParty=nullptr, const char *relyingParty=nullptr) const
 

Protected Member Functions

 AttributeDecoder (const xercesc::DOMElement *e)
 Constructor. More...
 
virtual Attribute_decode (Attribute *attr) const
 Helper method to handle base class decoding housekeeping. More...
 
virtual std::pair< std::vector< xmltooling::XMLObject * >::const_iterator, std::vector< xmltooling::XMLObject * >::const_iterator > valueRange (const xmltooling::GenericRequest *request, const std::vector< xmltooling::XMLObject *> &objects) const
 Helper method that returns a range of objects the decoder should operate on, based on the language settings of the decoder and the client request. More...
 

Protected Attributes

bool m_caseSensitive
 Flag for case sensitivity of decoded attributes. More...
 
bool m_internal
 Flag for hiding attributes from CGI export. More...
 
bool m_langAware
 Flag for language aware decoding. More...
 
std::string m_hashAlg
 Hash algorithm to apply to decoded values. More...
 

Detailed Description

Decodes XML objects into resolved Attributes.

Constructor & Destructor Documentation

◆ AttributeDecoder()

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

Constructor.

Parameters
eroot of DOM to configure the decoder

Member Function Documentation

◆ _decode()

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

Helper method to handle base class decoding housekeeping.

Parameters
attrthe new Attribute object being created
Returns
the attr parameter

◆ decode() [1/2]

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

Decodes an XMLObject into a resolved Attribute.

Parameters
requestrequest triggering the decode, if any
idsarray containing primary identifier in first position, followed by any aliases
xmlObjectXMLObject to decode
assertingPartyname of the party asserting the attribute
relyingPartyname of the party relying on the attribute
Returns
a resolved Attribute, or nullptr

◆ decode() [2/2]

virtual Attribute* shibsp::AttributeDecoder::decode ( const std::vector< std::string > &  ids,
const xmltooling::XMLObject *  xmlObject,
const char *  assertingParty = nullptr,
const char *  relyingParty = nullptr 
) const
virtual
Deprecated:
Decodes an XMLObject into a resolved Attribute.
Parameters
idsarray containing primary identifier in first position, followed by any aliases
xmlObjectXMLObject to decode
assertingPartyname of the party asserting the attribute
relyingPartyname of the party relying on the attribute
Returns
a resolved Attribute, or nullptr

◆ valueRange()

virtual std::pair<std::vector<xmltooling::XMLObject*>::const_iterator,std::vector<xmltooling::XMLObject*>::const_iterator> shibsp::AttributeDecoder::valueRange ( const xmltooling::GenericRequest *  request,
const std::vector< xmltooling::XMLObject *> &  objects 
) const
protectedvirtual

Helper method that returns a range of objects the decoder should operate on, based on the language settings of the decoder and the client request.

Parameters
requestthe client request, if any
objectsthe objects to examine
Returns
a pair of iterators representing the range of objects to examine

Member Data Documentation

◆ m_caseSensitive

bool shibsp::AttributeDecoder::m_caseSensitive
protected

Flag for case sensitivity of decoded attributes.

◆ m_hashAlg

std::string shibsp::AttributeDecoder::m_hashAlg
protected

Hash algorithm to apply to decoded values.

◆ m_internal

bool shibsp::AttributeDecoder::m_internal
protected

Flag for hiding attributes from CGI export.

◆ m_langAware

bool shibsp::AttributeDecoder::m_langAware
protected

Flag for language aware decoding.


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