shibsp::DOMPropertySet Class Reference

DOM-based property set implementation. More...

#include <shibsp/util/DOMPropertySet.h>

Inheritance diagram for shibsp::DOMPropertySet:
shibsp::PropertySet shibsp::AbstractHandler shibsp::XMLApplication shibsp::XMLConfigImpl shibsp::AssertionConsumerService shibsp::SecuredHandler

List of all members.

Classes

class  Remapper
 Interface that remaps property names for legacy support. More...
class  STLRemapper
 Concrete remapper that relies on an STL map. More...

Public Member Functions

const PropertySetgetParent () const
 Returns parent of this PropertySet, if any.
void setParent (const PropertySet *parent)
std::pair< bool, bool > getBool (const char *name, const char *ns=nullptr) const
 Returns a boolean-valued property.
std::pair< bool, const char * > getString (const char *name, const char *ns=nullptr) const
 Returns a string-valued property.
std::pair< bool, const XMLCh * > getXMLString (const char *name, const char *ns=nullptr) const
 Returns a Unicode string-valued property.
std::pair< bool, unsigned int > getUnsignedInt (const char *name, const char *ns=nullptr) const
 Returns an unsigned integer-valued property.
std::pair< bool, int > getInt (const char *name, const char *ns=nullptr) const
 Returns an integer-valued property.
const PropertySetgetPropertySet (const char *name, const char *ns=shibspconstants::ASCII_SHIBSPCONFIG_NS) const
 Returns a nested property set.
const xercesc::DOMElement * getElement () const
 Returns a DOM element representing the property container, if any.
void load (const xercesc::DOMElement *e, xmltooling::logging::Category *log=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const Remapper *remapper=nullptr, const xmltooling::QName *unsetter=nullptr)
 Loads the property set from a DOM element.

Protected Member Functions

bool setProperty (const char *name, const char *val, const char *ns=nullptr)
 Post-load injection of a property, for use by subclasses.

Detailed Description

DOM-based property set implementation.


Member Function Documentation

std::pair<bool,bool> shibsp::DOMPropertySet::getBool ( const char *  name,
const char *  ns = nullptr 
) const [virtual]

Returns a boolean-valued property.

Parameters:
name property name
ns property namespace, or nullptr
Returns:
a pair consisting of a nullptr indicator and the property value iff the indicator is true

Implements shibsp::PropertySet.

const xercesc::DOMElement* shibsp::DOMPropertySet::getElement (  )  const [virtual]

Returns a DOM element representing the property container, if any.

Returns:
a DOM element, or nullptr

Implements shibsp::PropertySet.

std::pair<bool,int> shibsp::DOMPropertySet::getInt ( const char *  name,
const char *  ns = nullptr 
) const [virtual]

Returns an integer-valued property.

Parameters:
name property name
ns property namespace, or nullptr
Returns:
a pair consisting of a nullptr indicator and the property value iff the indicator is true

Implements shibsp::PropertySet.

const PropertySet* shibsp::DOMPropertySet::getParent (  )  const [virtual]

Returns parent of this PropertySet, if any.

Returns:
the parent object, or nullptr

Implements shibsp::PropertySet.

const PropertySet* shibsp::DOMPropertySet::getPropertySet ( const char *  name,
const char *  ns = shibspconstants::ASCII_SHIBSPCONFIG_NS 
) const [virtual]

Returns a nested property set.

Parameters:
name nested property set name
ns nested property set namespace, or nullptr
Returns:
the nested property set, or nullptr

Implements shibsp::PropertySet.

std::pair<bool,const char*> shibsp::DOMPropertySet::getString ( const char *  name,
const char *  ns = nullptr 
) const [virtual]

Returns a string-valued property.

Parameters:
name property name
ns property namespace, or nullptr
Returns:
a pair consisting of a nullptr indicator and the property value iff the indicator is true

Implements shibsp::PropertySet.

Reimplemented in shibsp::XMLApplication.

std::pair<bool,unsigned int> shibsp::DOMPropertySet::getUnsignedInt ( const char *  name,
const char *  ns = nullptr 
) const [virtual]

Returns an unsigned integer-valued property.

Parameters:
name property name
ns property namespace, or nullptr
Returns:
a pair consisting of a nullptr indicator and the property value iff the indicator is true

Implements shibsp::PropertySet.

std::pair<bool,const XMLCh*> shibsp::DOMPropertySet::getXMLString ( const char *  name,
const char *  ns = nullptr 
) const [virtual]

Returns a Unicode string-valued property.

Parameters:
name property name
ns property namespace, or nullptr
Returns:
a pair consisting of a nullptr indicator and the property value iff the indicator is true

Implements shibsp::PropertySet.

Reimplemented in shibsp::XMLApplication.

void shibsp::DOMPropertySet::load ( const xercesc::DOMElement *  e,
xmltooling::logging::Category *  log = nullptr,
xercesc::DOMNodeFilter *  filter = nullptr,
const Remapper remapper = nullptr,
const xmltooling::QName *  unsetter = nullptr 
)

Loads the property set from a DOM element.

Parameters:
e root element of property set
log optional log object for tracing
filter optional filter controls what child elements to include as nested PropertySets
remapper optional mapper of property rename rules for legacy property support
unsetter optional name of a property containing a list of property names to "unset"
bool shibsp::DOMPropertySet::setProperty ( const char *  name,
const char *  val,
const char *  ns = nullptr 
) [protected]

Post-load injection of a property, for use by subclasses.

Parameters:
name property name
val property value
ns property namespace
Returns:
true iff the property was successfully set

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

Generated on 15 Dec 2020 for shibboleth-3.2.0 by  doxygen 1.6.1