DOM-based property set implementation.
More...
#include <shibsp/util/DOMPropertySet.h>
|
const PropertySet * | getParent () const |
| Returns parent of this PropertySet, if any. More...
|
|
void | setParent (const PropertySet *parent) |
| Establishes a "parent" PropertySet to supply inherited settings. More...
|
|
std::pair< bool, bool > | getBool (const char *name, const char *ns=nullptr) const |
| Returns a boolean-valued property. More...
|
|
std::pair< bool, const char * > | getString (const char *name, const char *ns=nullptr) const |
| Returns a string-valued property. More...
|
|
std::pair< bool, const XMLCh * > | getXMLString (const char *name, const char *ns=nullptr) const |
| Returns a Unicode string-valued property. More...
|
|
std::pair< bool, unsigned int > | getUnsignedInt (const char *name, const char *ns=nullptr) const |
| Returns an unsigned integer-valued property. More...
|
|
std::pair< bool, int > | getInt (const char *name, const char *ns=nullptr) const |
| Returns an integer-valued property. More...
|
|
void | getAll (std::map< std::string, const char *> &properties) const |
| Returns a map of all known properties in string form. More...
|
|
const PropertySet * | getPropertySet (const char *name, const char *ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const |
| Returns a nested property set. More...
|
|
const xercesc::DOMElement * | getElement () const |
| Returns a DOM element representing the property container, if any. More...
|
|
void | load (const xercesc::DOMElement *e, xmltooling::logging::Category *log=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const std::map< std::string, std::string > *remapper=nullptr) |
| Loads the property set from a DOM element. More...
|
|
|
bool | setProperty (const char *name, const char *val, const char *ns=nullptr) |
| Post-load injection of a property, for use by subclasses. More...
|
|
DOM-based property set implementation.
◆ getAll()
void shibsp::DOMPropertySet::getAll |
( |
std::map< std::string, const char *> & |
properties | ) |
const |
|
virtual |
Returns a map of all known properties in string form.
- Parameters
-
properties | map to populate |
Implements shibsp::PropertySet.
◆ getBool()
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.
◆ getElement()
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.
◆ getInt()
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.
◆ getParent()
const PropertySet* shibsp::DOMPropertySet::getParent |
( |
| ) |
const |
|
virtual |
◆ getPropertySet()
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.
◆ getString()
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.
◆ getUnsignedInt()
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.
◆ getXMLString()
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.
◆ load()
void shibsp::DOMPropertySet::load |
( |
const xercesc::DOMElement * |
e, |
|
|
xmltooling::logging::Category * |
log = nullptr , |
|
|
xercesc::DOMNodeFilter * |
filter = nullptr , |
|
|
const std::map< std::string, std::string > * |
remapper = 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 map of property rename rules for legacy property support |
◆ setParent()
void shibsp::DOMPropertySet::setParent |
( |
const PropertySet * |
parent | ) |
|
|
virtual |
◆ setProperty()
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: