2 * Copyright 2001-2010 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * @file shibsp/util/DOMPropertySet.h
20 * DOM-based property set implementation.
23 #ifndef __shibsp_dompropset_h__
24 #define __shibsp_dompropset_h__
26 #include <shibsp/util/PropertySet.h>
28 #include <xmltooling/logging.h>
33 * DOM-based property set implementation.
35 class SHIBSP_API DOMPropertySet : public virtual PropertySet
40 virtual ~DOMPropertySet();
42 const PropertySet* getParent() const;
43 void setParent(const PropertySet* parent);
44 std::pair<bool,bool> getBool(const char* name, const char* ns=nullptr) const;
45 std::pair<bool,const char*> getString(const char* name, const char* ns=nullptr) const;
46 std::pair<bool,const XMLCh*> getXMLString(const char* name, const char* ns=nullptr) const;
47 std::pair<bool,unsigned int> getUnsignedInt(const char* name, const char* ns=nullptr) const;
48 std::pair<bool,int> getInt(const char* name, const char* ns=nullptr) const;
49 void getAll(std::map<std::string,const char*>& properties) const;
50 const PropertySet* getPropertySet(const char* name, const char* ns=shibspconstants::ASCII_SHIB2SPCONFIG_NS) const;
51 const xercesc::DOMElement* getElement() const;
54 * Loads the property set from a DOM element.
56 * @param e root element of property set
57 * @param log optional log object for tracing
58 * @param filter optional filter controls what child elements to include as nested PropertySets
59 * @param remapper optional map of property rename rules for legacy property support
62 const xercesc::DOMElement* e,
63 xmltooling::logging::Category* log=nullptr,
64 xercesc::DOMNodeFilter* filter=nullptr,
65 const std::map<std::string,std::string>* remapper=nullptr
70 * Post-load injection of a property, for use by subclasses.
72 * @param name property name
73 * @param val property value
74 * @param ns property namespace
75 * @return true iff the property was successfully set
77 bool setProperty(const char* name, const char* val, const char* ns=nullptr);
80 const PropertySet* m_parent;
81 const xercesc::DOMElement* m_root;
82 std::map<std::string,std::pair<char*,const XMLCh*> > m_map;
83 std::map<std::string,DOMPropertySet*> m_nested;
84 std::vector<xmltooling::xstring> m_injected;
89 #endif /* __shibsp_dompropset_h__ */