2 * Copyright 2001-2007 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 AbstractXMLObjectMarshaller.h
20 * A mix-in to implement object marshalling with DOM reuse.
23 #if !defined(__xmltooling_xmlmarshaller_h__)
24 #define __xmltooling_xmlmarshaller_h__
26 #include <xmltooling/AbstractDOMCachingXMLObject.h>
28 #if defined (_MSC_VER)
29 #pragma warning( push )
30 #pragma warning( disable : 4250 4251 )
33 namespace xmltooling {
36 * A mix-in to implement object marshalling with DOM reuse.
38 class XMLTOOL_API AbstractXMLObjectMarshaller : public virtual AbstractXMLObject
41 virtual ~AbstractXMLObjectMarshaller() {}
44 DOMDocument* document=NULL
45 #ifndef XMLTOOLING_NO_XMLSEC
46 ,const std::vector<xmlsignature::Signature*>* sigs=NULL
47 ,const Credential* credential=NULL
52 DOMElement* parentElement
53 #ifndef XMLTOOLING_NO_XMLSEC
54 ,const std::vector<xmlsignature::Signature*>* sigs=NULL
55 ,const Credential* credential=NULL
60 AbstractXMLObjectMarshaller() {}
63 * Sets the given element as the Document Element of the given Document.
64 * If the document already has a Document Element it is replaced by the given element.
66 * @param document the document
67 * @param element the Element that will serve as the Document Element
69 void setDocumentElement(DOMDocument* document, DOMElement* element) const {
70 DOMElement* documentRoot = document->getDocumentElement();
72 document->replaceChild(element, documentRoot);
74 document->appendChild(element);
77 #ifndef XMLTOOLING_NO_XMLSEC
79 * Marshalls the XMLObject into the given DOM Element.
80 * The DOM Element must be within a DOM tree rooted in the owning Document.
82 * @param targetElement the Element into which the XMLObject is marshalled into
83 * @param sigs optional array of signatures to create after marshalling
84 * @param credential optional credential to supply signing key and related info
86 * @throws MarshallingException thrown if there is a problem marshalling the object
87 * @throws SignatureException thrown if a problem occurs during signature creation
90 DOMElement* targetElement, const std::vector<xmlsignature::Signature*>* sigs, const Credential* credential=NULL
94 * Marshalls the XMLObject into the given DOM Element.
95 * The DOM Element must be within a DOM tree rooted in the owning Document.
97 * @param targetElement the Element into which the XMLObject is marshalled into
99 * @throws MarshallingException thrown if there is a problem marshalling the object
101 void marshallInto(DOMElement* targetElement) const;
105 * Creates an xsi:type attribute, corresponding to the given type of the XMLObject, on the DOM element.
107 * @param domElement the DOM element
109 * @throws MarshallingException thrown if the type on the XMLObject is doesn't contain
110 * a local name, prefix, and namespace URI
112 void marshallElementType(DOMElement* domElement) const;
115 * Creates the xmlns attributes for any namespaces set on the XMLObject.
117 * @param domElement the DOM element the namespaces will be added to
119 void marshallNamespaces(DOMElement* domElement) const;
121 #ifndef XMLTOOLING_NO_XMLSEC
123 * Marshalls the text content and/or child elements of the XMLObject.
125 * @param domElement the DOM element that will recieved the marshalled children
126 * @param credential optional credential to supply signing key and related info
128 * @throws MarshallingException thrown if there is a problem marshalling a child element
130 void marshallContent(DOMElement* domElement, const Credential* credential) const;
133 * Marshalls the text content and/or child elements of the XMLObject.
135 * @param domElement the DOM element that will recieved the marshalled children
137 * @throws MarshallingException thrown if there is a problem marshalling a child element
139 void marshallContent(DOMElement* domElement) const;
143 * Marshalls the attributes from the XMLObject into the given DOM element.
145 * @param domElement the DOM Element into which attributes will be marshalled
147 * @throws MarshallingException thrown if there is a problem marshalling an attribute
149 virtual void marshallAttributes(DOMElement* domElement) const {}
154 #if defined (_MSC_VER)
155 #pragma warning( pop )
158 #endif /* __xmltooling_xmlmarshaller_h__ */