-/*\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/io/Marshaller.h>\r
-\r
-namespace xmltooling {\r
-\r
- /**\r
- * A thread-safe abstract marshaller.\r
- */\r
- class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual Marshaller\r
- {\r
- public:\r
- virtual ~AbstractXMLObjectMarshaller() {}\r
-\r
- /**\r
- * @see Marshaller::marshall(XMLObject*,DOMDocument*)\r
- */\r
- DOMElement* marshall(XMLObject* xmlObject, DOMDocument* document=NULL) const;\r
-\r
- /**\r
- * @see Marshaller::marshall(XMLObject*,DOMElement*)\r
- */\r
- DOMElement* marshall(XMLObject* xmlObject, DOMElement* parentElement) const;\r
- \r
- \r
- protected:\r
- /**\r
- * Constructor.\r
- * \r
- * @param targetNamespaceURI the namespace URI of either the schema type QName or element QName of the elements this\r
- * marshaller operates on\r
- * @param targetLocalName the local name of either the schema type QName or element QName of the elements this\r
- * marshaller operates on\r
- */\r
- AbstractXMLObjectMarshaller(const XMLCh* targetNamespaceURI, const XMLCh* targetLocalName);\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(documentRoot, element);\r
- else\r
- document->appendChild(element);\r
- }\r
- \r
- /**\r
- * Marshalls the given XMLObject into the given DOM Element.\r
- * The DOM Element must be within a DOM tree rooted in the owning Document.\r
- * \r
- * @param xmlObject the XMLObject to marshall\r
- * @param targetElement the Element into which the XMLObject is marshalled into\r
- * @throws MarshallingException thrown if there is a problem marshalling the object\r
- */\r
- void marshallInto(XMLObject& xmlObject, DOMElement* targetElement) const;\r
- \r
- /**\r
- * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.\r
- * \r
- * @param xmlObject the XMLObject\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(XMLObject& xmlObject, DOMElement* domElement) const;\r
-\r
- /**\r
- * Creates the xmlns attributes for any namespaces set on the given XMLObject.\r
- * \r
- * @param xmlObject the XMLObject\r
- * @param domElement the DOM element the namespaces will be added to\r
- */\r
- void marshallNamespaces(const XMLObject& xmlObject, DOMElement* domElement) const;\r
- \r
- /**\r
- * Marshalls the child elements of the given XMLObject.\r
- * \r
- * @param xmlObject the XMLObject whose children will be marshalled\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 marshallChildElements(const XMLObject& xmlObject, DOMElement* domElement) const;\r
-\r
- /**\r
- * Marshalls the attributes from the given XMLObject into the given DOM element.\r
- * The XMLObject passed to this method is guaranteed to be of the target name\r
- * specified during this marshaller's construction.\r
- * \r
- * @param xmlObject the XMLObject being marshalled\r
- * @param domElement the DOM Element into which attributes will be marshalled\r
- * \r
- * @throws UnmarshallingException thrown if there is a problem unmarshalling an attribute\r
- */\r
- virtual void marshallAttributes(const XMLObject& xmlObject, DOMElement* domElement) const=0;\r
-\r
- /**\r
- * Marshalls data from the XMLObject into content of the DOM Element.\r
- * \r
- * @param xmlObject the XMLObject\r
- * @param domElement the DOM element recieving the content\r
- */\r
- virtual void marshallElementContent(const XMLObject& xmlObject, DOMElement* domElement) const=0;\r
-\r
- void* m_log;\r
- private:\r
- QName m_targetQName;\r
- };\r
- \r
-};\r
-\r
-#endif /* __xmltooling_xmlmarshaller_h__ */\r
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you 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 xmltooling/io/AbstractXMLObjectMarshaller.h
+ *
+ * A mix-in to implement object marshalling with DOM reuse.
+ */
+
+#ifndef __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 mix-in to implement object marshalling with DOM reuse.
+ */
+ class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject
+ {
+ public:
+ virtual ~AbstractXMLObjectMarshaller();
+
+ xercesc::DOMElement* marshall(
+ xercesc::DOMDocument* document=nullptr
+#ifndef XMLTOOLING_NO_XMLSEC
+ ,const std::vector<xmlsignature::Signature*>* sigs=nullptr
+ ,const Credential* credential=nullptr
+#endif
+ ) const;
+
+ xercesc::DOMElement* marshall(
+ xercesc::DOMElement* parentElement
+#ifndef XMLTOOLING_NO_XMLSEC
+ ,const std::vector<xmlsignature::Signature*>* sigs=nullptr
+ ,const Credential* credential=nullptr
+#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(xercesc::DOMDocument* document, xercesc::DOMElement* element) const;
+
+#ifndef XMLTOOLING_NO_XMLSEC
+ /**
+ * 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 sigs optional array of signatures to create after marshalling
+ * @param credential optional credential to supply signing key and related info
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling the object
+ * @throws SignatureException thrown if a problem occurs during signature creation
+ */
+ void marshallInto(
+ xercesc::DOMElement* targetElement, const std::vector<xmlsignature::Signature*>* sigs, const Credential* credential=nullptr
+ ) const;
+#else
+ /**
+ * 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
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling the object
+ */
+ void marshallInto(xercesc::DOMElement* targetElement) const;
+#endif
+
+ /**
+ * 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(xercesc::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(xercesc::DOMElement* domElement) const;
+
+#ifndef XMLTOOLING_NO_XMLSEC
+ /**
+ * Marshalls the text content and/or child elements of the XMLObject.
+ *
+ * @param domElement the DOM element that will recieved the marshalled children
+ * @param credential optional credential to supply signing key and related info
+ *
+ * @throws MarshallingException thrown if there is a problem marshalling a child element
+ */
+ void marshallContent(xercesc::DOMElement* domElement, const Credential* credential) const;
+#else
+ /**
+ * 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(xercesc::DOMElement* domElement) const;
+#endif
+
+ /**
+ * 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(xercesc::DOMElement* domElement) const;
+
+ /**
+ * Called before marshalling in the event that a new DOM is being generated.
+ * <p>Allows objects to adjust internal state prior to the marshalling step.
+ */
+ virtual void prepareForMarshalling() const;
+ };
+
+};
+
+#if defined (_MSC_VER)
+ #pragma warning( pop )
+#endif
+
+#endif /* __xmltooling_xmlmarshaller_h__ */
projects / shibboleth / cpp-xmltooling.git / blobdiff