2 * Copyright 2001-2009 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 * AbstractXMLObjectUnmarshaller.cpp
20 * A thread-safe abstract unmarshaller.
24 #include "exceptions.h"
25 #include "XMLObjectBuilder.h"
26 #include "io/AbstractXMLObjectUnmarshaller.h"
28 #include "util/XMLConstants.h"
29 #include "util/XMLHelper.h"
31 #include <xercesc/util/XMLUniDefs.hpp>
33 using namespace xmlconstants;
34 using namespace xmltooling;
35 using namespace xercesc;
38 AbstractXMLObjectUnmarshaller::AbstractXMLObjectUnmarshaller()
42 AbstractXMLObjectUnmarshaller::~AbstractXMLObjectUnmarshaller()
46 XMLObject* AbstractXMLObjectUnmarshaller::unmarshall(DOMElement* element, bool bindDocument)
49 xmltooling::NDC ndc("unmarshall");
52 if (getDOM() || hasParent())
53 throw UnmarshallingException("Object already contains data, it cannot be unmarshalled at this stage.");
55 if (!XMLString::equals(element->getNamespaceURI(),getElementQName().getNamespaceURI()) ||
56 !XMLString::equals(element->getLocalName(),getElementQName().getLocalPart())) {
57 throw UnmarshallingException("Unrecognized element supplied to implementation for unmarshalling.");
60 if (m_log.isDebugEnabled()) {
61 auto_ptr_char dname(element->getNodeName());
62 m_log.debug("unmarshalling DOM element (%s)", dname.get());
65 if (element->hasAttributes()) {
66 unmarshallAttributes(element);
69 unmarshallContent(element);
71 setDOM(element,bindDocument);
75 void AbstractXMLObjectUnmarshaller::unmarshallAttributes(const DOMElement* domElement)
78 xmltooling::NDC ndc("unmarshallAttributes");
81 if (m_log.isDebugEnabled()) {
82 auto_ptr_char dname(domElement->getNodeName());
83 m_log.debug("unmarshalling attributes for DOM element (%s)", dname.get());
86 DOMNamedNodeMap* attributes = domElement->getAttributes();
88 m_log.debug("no attributes to unmarshall");
94 for (XMLSize_t i=0; i<attributes->getLength(); i++) {
95 childNode = attributes->item(i);
97 // The child node should always be an attribute, but just in case
98 if (childNode->getNodeType() != DOMNode::ATTRIBUTE_NODE) {
99 m_log.debug("encountered child node of type %d in attribute list, ignoring it", childNode->getNodeType());
103 attribute = static_cast<DOMAttr*>(childNode);
105 const XMLCh* nsuri=attribute->getNamespaceURI();
106 if (XMLString::equals(nsuri,XMLNS_NS)) {
107 if (XMLString::equals(attribute->getLocalName(),XMLNS_PREFIX)) {
108 m_log.debug("found default namespace declaration, adding it to the list of namespaces on the XMLObject");
109 addNamespace(Namespace(attribute->getValue(), NULL, true));
111 else if (XMLString::equals(attribute->getLocalName(),XML_PREFIX) && XMLString::equals(attribute->getNodeValue(),XML_NS)) {
112 m_log.debug("found standard xml prefix declaration, ignoring as superfluous");
115 m_log.debug("found namespace declaration, adding it to the list of namespaces on the XMLObject");
116 addNamespace(Namespace(attribute->getValue(), attribute->getLocalName(), true));
120 else if (XMLString::equals(nsuri,XSI_NS)) {
121 static const XMLCh type[]= UNICODE_LITERAL_4(t,y,p,e);
122 static const XMLCh schemaLocation[]= UNICODE_LITERAL_14(s,c,h,e,m,a,L,o,c,a,t,i,o,n);
123 static const XMLCh noNamespaceSchemaLocation[]= UNICODE_LITERAL_25(n,o,N,a,m,e,s,p,a,c,e,S,c,h,e,m,a,L,o,c,a,t,i,o,n);
124 static const XMLCh _nil[]= UNICODE_LITERAL_3(n,i,l);
125 if (XMLString::equals(attribute->getLocalName(),type)) {
126 m_log.debug("skipping xsi:type declaration");
129 else if (XMLString::equals(attribute->getLocalName(),schemaLocation)) {
130 m_log.debug("storing off xsi:schemaLocation attribute");
131 if (m_schemaLocation)
132 XMLString::release(&m_schemaLocation);
133 m_schemaLocation=XMLString::replicate(attribute->getValue());
136 else if (XMLString::equals(attribute->getLocalName(),noNamespaceSchemaLocation)) {
137 m_log.debug("storing off xsi:noNamespaceSchemaLocation attribute");
138 if (m_noNamespaceSchemaLocation)
139 XMLString::release(&m_noNamespaceSchemaLocation);
140 m_schemaLocation=XMLString::replicate(attribute->getValue());
141 m_noNamespaceSchemaLocation=XMLString::replicate(attribute->getValue());
144 else if (XMLString::equals(attribute->getLocalName(), _nil)) {
145 m_log.debug("processing xsi:nil attribute");
146 setNil(attribute->getValue());
150 else if (nsuri && !XMLString::equals(nsuri,XML_NS)) {
151 m_log.debug("found namespace-qualified attribute, adding prefix to the list of namespaces on the XMLObject");
152 addNamespace(Namespace(nsuri, attribute->getPrefix()));
155 m_log.debug("processing generic attribute");
156 processAttribute(attribute);
160 void AbstractXMLObjectUnmarshaller::unmarshallContent(const DOMElement* domElement)
163 xmltooling::NDC ndc("unmarshallContent");
166 if (m_log.isDebugEnabled()) {
167 auto_ptr_char dname(domElement->getNodeName());
168 m_log.debug("unmarshalling child nodes of DOM element (%s)", dname.get());
171 DOMNode* childNode = domElement->getFirstChild();
173 m_log.debug("element had no children");
177 unsigned int position = 0;
179 if (childNode->getNodeType() == DOMNode::ELEMENT_NODE) {
180 const XMLObjectBuilder* builder = XMLObjectBuilder::getBuilder(static_cast<DOMElement*>(childNode));
182 auto_ptr<QName> cname(XMLHelper::getNodeQName(childNode));
183 m_log.error("no default builder installed, found unknown child element (%s)", cname->toString().c_str());
184 throw UnmarshallingException("Unmarshaller found unknown child element, but no default builder was found.");
187 if (m_log.isDebugEnabled()) {
188 auto_ptr<QName> cname(XMLHelper::getNodeQName(childNode));
189 m_log.debug("unmarshalling child element (%s)", cname->toString().c_str());
192 // Retain ownership of the unmarshalled child until it's processed by the parent.
193 auto_ptr<XMLObject> childObject(builder->buildFromElement(static_cast<DOMElement*>(childNode)));
194 processChildElement(childObject.get(), static_cast<DOMElement*>(childNode));
195 childObject.release();
197 // Advance the text node position marker.
200 else if (childNode->getNodeType() == DOMNode::TEXT_NODE || childNode->getNodeType() == DOMNode::CDATA_SECTION_NODE) {
201 m_log.debug("processing text content at position (%d)", position);
202 setTextContent(childNode->getNodeValue(), position);
205 childNode = childNode->getNextSibling();
209 void AbstractXMLObjectUnmarshaller::processChildElement(XMLObject* child, const DOMElement* childRoot)
211 throw UnmarshallingException("Invalid child element: $1",params(1,child->getElementQName().toString().c_str()));
214 void AbstractXMLObjectUnmarshaller::processAttribute(const DOMAttr* attribute)
216 auto_ptr<QName> q(XMLHelper::getNodeQName(attribute));
217 throw UnmarshallingException("Invalid attribute: $1",params(1,q->toString().c_str()));