-/*\r
-* Copyright 2001-2006 Internet2\r
- * \r
-* Licensed under the Apache License, Version 2.0 (the "License");\r
- * you may not use this file except in compliance with the License.\r
- * You may obtain a copy of the License at\r
- *\r
- * http://www.apache.org/licenses/LICENSE-2.0\r
- *\r
- * Unless required by applicable law or agreed to in writing, software\r
- * distributed under the License is distributed on an "AS IS" BASIS,\r
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
- * See the License for the specific language governing permissions and\r
- * limitations under the License.\r
- */\r
-\r
-/**\r
- * @file AbstractXMLObjectMarshaller.h\r
- * \r
- * A thread-safe abstract marshaller.\r
- */\r
-\r
-#if !defined(__xmltooling_xmlmarshaller_h__)\r
-#define __xmltooling_xmlmarshaller_h__\r
-\r
-#include <xmltooling/AbstractDOMCachingXMLObject.h>\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( push )\r
- #pragma warning( disable : 4250 4251 )\r
-#endif\r
-\r
-namespace xmltooling {\r
-\r
- /**\r
- * A thread-safe abstract marshaller.\r
- */\r
- class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject\r
- {\r
- public:\r
- virtual ~AbstractXMLObjectMarshaller() {}\r
-\r
- DOMElement* marshall(\r
- DOMDocument* document=NULL\r
-#ifndef XMLTOOLING_NO_XMLSEC\r
- ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
-#endif\r
- ) const;\r
-\r
- DOMElement* marshall(\r
- DOMElement* parentElement\r
-#ifndef XMLTOOLING_NO_XMLSEC\r
- ,const std::vector<xmlsignature::Signature*>* sigs=NULL\r
-#endif\r
- ) const;\r
- \r
- protected:\r
- AbstractXMLObjectMarshaller() {}\r
-\r
- /**\r
- * Sets the given element as the Document Element of the given Document.\r
- * If the document already has a Document Element it is replaced by the given element.\r
- * \r
- * @param document the document\r
- * @param element the Element that will serve as the Document Element\r
- */\r
- void setDocumentElement(DOMDocument* document, DOMElement* element) const {\r
- DOMElement* documentRoot = document->getDocumentElement();\r
- if (documentRoot)\r
- document->replaceChild(element, documentRoot);\r
- else\r
- document->appendChild(element);\r
- }\r
- \r
- /**\r
- * Marshalls the XMLObject into the given DOM Element.\r
- * The DOM Element must be within a DOM tree rooted in the owning Document.\r
- * \r
- * @param targetElement the Element into which the XMLObject is marshalled into\r
- * @param ctx optional marshalling context\r
- * \r
- * @throws MarshallingException thrown if there is a problem marshalling the object\r
- * @throws SignatureException thrown if a problem occurs during signature creation \r
- */\r
- void marshallInto(\r
- DOMElement* targetElement\r
-#ifndef XMLTOOLING_NO_XMLSEC\r
- ,const std::vector<xmlsignature::Signature*>* sigs\r
-#endif\r
- ) const;\r
- \r
- /**\r
- * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.\r
- * \r
- * @param domElement the DOM element\r
- * \r
- * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain\r
- * a local name, prefix, and namespace URI\r
- */\r
- void marshallElementType(DOMElement* domElement) const;\r
-\r
- /**\r
- * Creates the xmlns attributes for any namespaces set on the XMLObject.\r
- * \r
- * @param domElement the DOM element the namespaces will be added to\r
- */\r
- void marshallNamespaces(DOMElement* domElement) const;\r
- \r
- /**\r
- * Marshalls the text content and/or child elements of the XMLObject.\r
- * \r
- * @param domElement the DOM element that will recieved the marshalled children\r
- * \r
- * @throws MarshallingException thrown if there is a problem marshalling a child element\r
- */\r
- void marshallContent(DOMElement* domElement) const;\r
-\r
- /**\r
- * Marshalls the attributes from the XMLObject into the given DOM element.\r
- * \r
- * @param domElement the DOM Element into which attributes will be marshalled\r
- * \r
- * @throws MarshallingException thrown if there is a problem marshalling an attribute\r
- */\r
- virtual void marshallAttributes(DOMElement* domElement) const {}\r
- };\r
- \r
-};\r
-\r
-#if defined (_MSC_VER)\r
- #pragma warning( pop )\r
-#endif\r
-\r
-#endif /* __xmltooling_xmlmarshaller_h__ */\r
+/*
+* Copyright 2001-2006 Internet2
+ *
+* Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @file AbstractXMLObjectMarshaller.h
+ *
+ * A thread-safe abstract marshaller.
+ */
+
+#if !defined(__xmltooling_xmlmarshaller_h__)
+#define __xmltooling_xmlmarshaller_h__
+
+#include <xmltooling/AbstractDOMCachingXMLObject.h>
+
+#if defined (_MSC_VER)
+ #pragma warning( push )
+ #pragma warning( disable : 4250 4251 )
+#endif
+
+namespace xmltooling {
+
+ /**
+ * A thread-safe abstract marshaller.
+ */
+ class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject
+ {
+ public:
+ virtual ~AbstractXMLObjectMarshaller() {}
+
+ DOMElement* marshall(
+ DOMDocument* document=NULL
+#ifndef XMLTOOLING_NO_XMLSEC
+ ,const std::vector<xmlsignature::Signature*>* sigs=NULL
+#endif
+ ) const;
+
+ DOMElement* marshall(
+ DOMElement* parentElement
+#ifndef XMLTOOLING_NO_XMLSEC
+ ,const std::vector<xmlsignature::Signature*>* sigs=NULL
+#endif
+ ) const;
+
+ protected:
+ AbstractXMLObjectMarshaller() {}
+
+ /**
+ * Sets the given element as the Document Element of the given Document.
+ * If the document already has a Document Element it is replaced by the given element.
+ *
+ * @param document the document
+ * @param element the Element that will serve as the Document Element
+ */
+ void setDocumentElement(DOMDocument* document, DOMElement* element) const {
+ DOMElement* documentRoot = document->getDocumentElement();
+ if (documentRoot)
+ document->replaceChild(element, documentRoot);
+ else
+ document->appendChild(element);
+ }
+
+ /**
+ * Marshalls the XMLObject into the given DOM Element.
+ * The DOM Element must be within a DOM tree rooted in the owning Document.
+ *
+ * @param targetElement the Element into which the XMLObject is marshalled into
+ * @param ctx optional marshalling context
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling the object
+ * @throws SignatureException thrown if a problem occurs during signature creation
+ */
+ void marshallInto(
+ DOMElement* targetElement
+#ifndef XMLTOOLING_NO_XMLSEC
+ ,const std::vector<xmlsignature::Signature*>* sigs
+#endif
+ ) const;
+
+ /**
+ * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.
+ *
+ * @param domElement the DOM element
+ *
+ * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain
+ * a local name, prefix, and namespace URI
+ */
+ void marshallElementType(DOMElement* domElement) const;
+
+ /**
+ * Creates the xmlns attributes for any namespaces set on the XMLObject.
+ *
+ * @param domElement the DOM element the namespaces will be added to
+ */
+ void marshallNamespaces(DOMElement* domElement) const;
+
+ /**
+ * Marshalls the text content and/or child elements of the XMLObject.
+ *
+ * @param domElement the DOM element that will recieved the marshalled children
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling a child element
+ */
+ void marshallContent(DOMElement* domElement) const;
+
+ /**
+ * Marshalls the attributes from the XMLObject into the given DOM element.
+ *
+ * @param domElement the DOM Element into which attributes will be marshalled
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling an attribute
+ */
+ virtual void marshallAttributes(DOMElement* domElement) const {}
+ };
+
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_xmlmarshaller_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff