2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.impl.codec.xml;
10 import static com.google.common.base.Preconditions.checkState;
12 import com.google.common.base.Function;
13 import com.google.common.base.Objects;
14 import com.google.common.base.Optional;
15 import com.google.common.base.Preconditions;
16 import com.google.common.base.Strings;
17 import com.google.common.collect.ImmutableList;
20 import java.util.ArrayList;
21 import java.util.Collection;
22 import java.util.Collections;
23 import java.util.List;
25 import java.util.Map.Entry;
28 import javax.activation.UnsupportedDataTypeException;
29 import javax.xml.parsers.DocumentBuilder;
30 import javax.xml.parsers.DocumentBuilderFactory;
31 import javax.xml.parsers.ParserConfigurationException;
32 import javax.xml.stream.XMLOutputFactory;
33 import javax.xml.stream.XMLStreamException;
34 import javax.xml.stream.XMLStreamWriter;
35 import javax.xml.transform.dom.DOMResult;
37 import org.opendaylight.yangtools.yang.common.QName;
38 import org.opendaylight.yangtools.yang.data.api.AttributesContainer;
39 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
40 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
41 import org.opendaylight.yangtools.yang.data.api.Node;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
44 import org.opendaylight.yangtools.yang.data.impl.SimpleNodeTOImpl;
45 import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
46 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
47 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
48 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
50 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
51 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
52 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
53 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
54 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
55 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
56 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
57 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
58 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
59 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
60 import org.slf4j.Logger;
61 import org.slf4j.LoggerFactory;
62 import org.w3c.dom.Attr;
63 import org.w3c.dom.Document;
64 import org.w3c.dom.Element;
65 import org.w3c.dom.NodeList;
67 public class XmlDocumentUtils {
68 private final static String RPC_REPLY_LOCAL_NAME = "rpc-reply";
69 private final static String RPC_REPLY_NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0";
70 private final static QName RPC_REPLY_QNAME = QName.create(URI.create(RPC_REPLY_NAMESPACE), null, RPC_REPLY_LOCAL_NAME);
72 private static class ElementWithSchemaContext {
74 SchemaContext schemaContext;
76 ElementWithSchemaContext(final Element element,final SchemaContext schemaContext) {
77 this.schemaContext = schemaContext;
78 this.element = element;
81 Element getElement() {
85 SchemaContext getSchemaContext() {
90 public static final QName OPERATION_ATTRIBUTE_QNAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "operation");
91 private static final Logger logger = LoggerFactory.getLogger(XmlDocumentUtils.class);
92 private static final XMLOutputFactory FACTORY = XMLOutputFactory.newFactory();
95 * Converts Data DOM structure to XML Document for specified XML Codec Provider and corresponding
96 * Data Node Container schema. The CompositeNode data parameter enters as root of Data DOM tree and will
97 * be transformed to root in XML Document. Each element of Data DOM tree is compared against specified Data
98 * Node Container Schema and transformed accordingly.
100 * @param data Data DOM root element
101 * @param schema Data Node Container Schema
102 * @param codecProvider XML Codec Provider
103 * @return new instance of XML Document
104 * @throws UnsupportedDataTypeException
106 public static Document toDocument(final CompositeNode data, final DataNodeContainer schema, final XmlCodecProvider codecProvider)
107 throws UnsupportedDataTypeException {
108 Preconditions.checkNotNull(data);
109 Preconditions.checkNotNull(schema);
111 if (!(schema instanceof ContainerSchemaNode || schema instanceof ListSchemaNode)) {
112 throw new UnsupportedDataTypeException("Schema can be ContainerSchemaNode or ListSchemaNode. Other types are not supported yet.");
115 final DOMResult result = new DOMResult(getDocument());
117 final XMLStreamWriter writer = FACTORY.createXMLStreamWriter(result);
118 XmlStreamUtils.create(codecProvider).writeDocument(writer, data, (SchemaNode)schema);
120 return (Document)result.getNode();
121 } catch (XMLStreamException e) {
122 logger.error("Failed to serialize data {}", data, e);
127 public static Document getDocument() {
128 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
131 DocumentBuilder bob = dbf.newDocumentBuilder();
132 doc = bob.newDocument();
133 } catch (ParserConfigurationException e) {
134 throw new RuntimeException(e);
140 * Converts Data DOM structure to XML Document for specified XML Codec Provider. The CompositeNode
141 * data parameter enters as root of Data DOM tree and will be transformed to root in XML Document. The child
142 * nodes of Data Tree are transformed accordingly.
144 * @param data Data DOM root element
145 * @param codecProvider XML Codec Provider
146 * @return new instance of XML Document
147 * @throws UnsupportedDataTypeException
149 public static Document toDocument(final CompositeNode data, final XmlCodecProvider codecProvider) {
150 final DOMResult result = new DOMResult(getDocument());
152 final XMLStreamWriter writer = FACTORY.createXMLStreamWriter(result);
153 XmlStreamUtils.create(codecProvider).writeDocument(writer, data);
155 return (Document)result.getNode();
156 } catch (XMLStreamException e) {
157 logger.error("Failed to serialize data {}", data, e);
162 private static final Element createElementFor(final Document doc, final QName qname, final Object obj) {
164 if (qname.getNamespace() != null) {
165 ret = doc.createElementNS(qname.getNamespace().toString(), qname.getLocalName());
167 ret = doc.createElementNS(null, qname.getLocalName());
170 if (obj instanceof AttributesContainer) {
171 final Map<QName, String> attrs = ((AttributesContainer)obj).getAttributes();
174 for (Entry<QName, String> attribute : attrs.entrySet()) {
175 ret.setAttributeNS(attribute.getKey().getNamespace().toString(), attribute.getKey().getLocalName(),
176 attribute.getValue());
184 public static Element createElementFor(final Document doc, final Node<?> data) {
185 return createElementFor(doc, data.getNodeType(), data);
188 public static Element createElementFor(final Document doc, final NormalizedNode<?, ?> data) {
189 return createElementFor(doc, data.getNodeType(), data);
192 public static Node<?> toDomNode(final Element xmlElement, final Optional<DataSchemaNode> schema,
193 final Optional<XmlCodecProvider> codecProvider) {
194 return toDomNode(xmlElement, schema, codecProvider, Optional.<SchemaContext>absent());
197 public static Node<?> toDomNode(final Element xmlElement, final Optional<DataSchemaNode> schema,
198 final Optional<XmlCodecProvider> codecProvider, final Optional<SchemaContext> schemaContext) {
199 if (schema.isPresent()) {
200 if(schemaContext.isPresent()) {
201 return toNodeWithSchema(xmlElement, schema.get(), codecProvider.or(XmlUtils.DEFAULT_XML_CODEC_PROVIDER), schemaContext.get());
203 return toNodeWithSchema(xmlElement, schema.get(), codecProvider.or(XmlUtils.DEFAULT_XML_CODEC_PROVIDER));
206 return toDomNode(xmlElement);
209 public static QName qNameFromElement(final Element xmlElement) {
210 String namespace = xmlElement.getNamespaceURI();
211 String localName = xmlElement.getLocalName();
212 return QName.create(namespace != null ? URI.create(namespace) : null, null, localName);
215 private static Node<?> toNodeWithSchema(final Element xmlElement, final DataSchemaNode schema, final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
216 checkQName(xmlElement, schema.getQName());
217 if (schema instanceof DataNodeContainer) {
218 return toCompositeNodeWithSchema(xmlElement, schema.getQName(), (DataNodeContainer) schema, codecProvider,schemaCtx);
219 } else if (schema instanceof LeafSchemaNode) {
220 return toSimpleNodeWithType(xmlElement, (LeafSchemaNode) schema, codecProvider,schemaCtx);
221 } else if (schema instanceof LeafListSchemaNode) {
222 return toSimpleNodeWithType(xmlElement, (LeafListSchemaNode) schema, codecProvider,schemaCtx);
227 private static Node<?> toNodeWithSchema(final Element xmlElement, final DataSchemaNode schema, final XmlCodecProvider codecProvider) {
228 return toNodeWithSchema(xmlElement, schema, codecProvider, null);
231 protected static Node<?> toSimpleNodeWithType(final Element xmlElement, final LeafSchemaNode schema,
232 final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
233 TypeDefinitionAwareCodec<? extends Object, ? extends TypeDefinition<?>> codec = codecProvider.codecFor(schema.getType());
234 String text = xmlElement.getTextContent();
237 value = codec.deserialize(text);
239 final TypeDefinition<?> baseType = XmlUtils.resolveBaseTypeFrom(schema.getType());
241 if (baseType instanceof org.opendaylight.yangtools.yang.model.util.InstanceIdentifierType) {
242 value = InstanceIdentifierForXmlCodec.deserialize(xmlElement,schemaCtx);
243 } else if(baseType instanceof IdentityrefTypeDefinition){
244 value = InstanceIdentifierForXmlCodec.toIdentity(xmlElement.getTextContent(), xmlElement, schemaCtx);
248 value = xmlElement.getTextContent();
251 Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
252 return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
255 private static Node<?> toSimpleNodeWithType(final Element xmlElement, final LeafListSchemaNode schema,
256 final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
257 TypeDefinitionAwareCodec<? extends Object, ? extends TypeDefinition<?>> codec = codecProvider.codecFor(schema.getType());
258 String text = xmlElement.getTextContent();
261 value = codec.deserialize(text);
263 if (schema.getType() instanceof org.opendaylight.yangtools.yang.model.util.InstanceIdentifierType) {
264 value = InstanceIdentifierForXmlCodec.deserialize(xmlElement,schemaCtx);
267 value = xmlElement.getTextContent();
270 Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
271 return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
274 private static Node<?> toCompositeNodeWithSchema(final Element xmlElement, final QName qName, final DataNodeContainer schema,
275 final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
276 List<Node<?>> values = toDomNodes(xmlElement, Optional.fromNullable(schema.getChildNodes()),schemaCtx);
277 Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
278 return ImmutableCompositeNode.create(qName, values, modifyAction.orNull());
281 public static Optional<ModifyAction> getModifyOperationFromAttributes(final Element xmlElement) {
282 Attr attributeNodeNS = xmlElement.getAttributeNodeNS(OPERATION_ATTRIBUTE_QNAME.getNamespace().toString(), OPERATION_ATTRIBUTE_QNAME.getLocalName());
283 if(attributeNodeNS == null) {
284 return Optional.absent();
287 ModifyAction action = ModifyAction.fromXmlValue(attributeNodeNS.getValue());
288 Preconditions.checkArgument(action.isOnElementPermitted(), "Unexpected operation %s on %s", action, xmlElement);
290 return Optional.of(action);
293 private static void checkQName(final Element xmlElement, final QName qName) {
294 checkState(Objects.equal(xmlElement.getNamespaceURI(), qName.getNamespace().toString()), "Not equal: %s to: %s for: %s and: %s", qName.getNamespace(), xmlElement.getNamespaceURI(), qName, xmlElement);
295 checkState(qName.getLocalName().equals(xmlElement.getLocalName()), "Not equal: %s to: %s for: %s and: %s", qName.getLocalName(), xmlElement.getLocalName(), qName, xmlElement);
298 public static final Optional<DataSchemaNode> findFirstSchema(final QName qname, final Iterable<DataSchemaNode> dataSchemaNode) {
299 if (dataSchemaNode != null && qname != null) {
300 for (DataSchemaNode dsn : dataSchemaNode) {
301 if (qname.isEqualWithoutRevision(dsn.getQName())) {
302 return Optional.<DataSchemaNode> of(dsn);
303 } else if (dsn instanceof ChoiceNode) {
304 for (ChoiceCaseNode choiceCase : ((ChoiceNode) dsn).getCases()) {
305 Optional<DataSchemaNode> foundDsn = findFirstSchema(qname, choiceCase.getChildNodes());
306 if (foundDsn != null && foundDsn.isPresent()) {
313 return Optional.absent();
316 public static Node<?> toDomNode(final Document doc) {
317 return toDomNode(doc.getDocumentElement());
320 private static Node<?> toDomNode(final Element element) {
321 QName qname = qNameFromElement(element);
323 ImmutableList.Builder<Node<?>> values = ImmutableList.<Node<?>> builder();
324 NodeList nodes = element.getChildNodes();
325 boolean isSimpleObject = true;
327 for (int i = 0; i < nodes.getLength(); i++) {
328 org.w3c.dom.Node child = nodes.item(i);
329 if (child instanceof Element) {
330 isSimpleObject = false;
331 values.add(toDomNode((Element) child));
333 if (isSimpleObject && child instanceof org.w3c.dom.Text) {
334 value = element.getTextContent();
335 if (!Strings.isNullOrEmpty(value)) {
336 isSimpleObject = true;
340 if (isSimpleObject) {
341 return new SimpleNodeTOImpl<>(qname, null, value);
343 return ImmutableCompositeNode.create(qname, values.build());
346 public static List<Node<?>> toDomNodes(final Element element, final Optional<? extends Iterable<DataSchemaNode>> context, final SchemaContext schemaCtx) {
347 return forEachChild(element.getChildNodes(),schemaCtx, new Function<ElementWithSchemaContext, Optional<Node<?>>>() {
350 public Optional<Node<?>> apply(final ElementWithSchemaContext input) {
351 if (context.isPresent()) {
352 QName partialQName = qNameFromElement(input.getElement());
353 Optional<DataSchemaNode> schemaNode = findFirstSchema(partialQName, context.get());
354 if (schemaNode.isPresent()) {
355 return Optional.<Node<?>> fromNullable(
356 toNodeWithSchema(input.getElement(), schemaNode.get(), XmlUtils.DEFAULT_XML_CODEC_PROVIDER, input.getSchemaContext()));
359 return Optional.<Node<?>> fromNullable(toDomNode(input.getElement()));
366 public static List<Node<?>> toDomNodes(final Element element, final Optional<? extends Iterable<DataSchemaNode>> context) {
367 return toDomNodes(element, context, null);
371 * Converts XML Document containing notification data from Netconf device to
372 * Data DOM Nodes. <br>
373 * By specification defined in <a
374 * href="http://tools.ietf.org/search/rfc6020#section-7.14">RFC 6020</a>
375 * there are xml elements containing notifications metadata, like eventTime
376 * or root notification element which specifies namespace for which is
377 * notification defined in yang model. Those elements MUST be stripped off
378 * notifications body. This method returns pure notification body which
379 * begins in element which is equal to notifications name defined in
380 * corresponding yang model. Rest of notification metadata are obfuscated,
381 * thus Data DOM contains only pure notification body.
384 * XML Document containing notification body
385 * @param notifications
386 * Notifications Definition Schema
387 * @return Data DOM Nodes containing xml notification body definition or
388 * <code>null</code> if there is no NotificationDefinition with
389 * Element with equal notification QName defined in XML Document.
391 public static CompositeNode notificationToDomNodes(final Document document,
392 final Optional<Set<NotificationDefinition>> notifications, final SchemaContext schemaCtx) {
393 if (notifications.isPresent() && (document != null) && (document.getDocumentElement() != null)) {
394 final NodeList originChildNodes = document.getDocumentElement().getChildNodes();
395 for (int i = 0; i < originChildNodes.getLength(); i++) {
396 org.w3c.dom.Node child = originChildNodes.item(i);
397 if (child instanceof Element) {
398 final Element childElement = (Element) child;
399 final QName partialQName = qNameFromElement(childElement);
400 final Optional<NotificationDefinition> notificationDef = findNotification(partialQName,
401 notifications.get());
402 if (notificationDef.isPresent()) {
403 final Iterable<DataSchemaNode> dataNodes = notificationDef.get().getChildNodes();
404 final List<Node<?>> domNodes = toDomNodes(childElement,
405 Optional.<Iterable<DataSchemaNode>> fromNullable(dataNodes),schemaCtx);
406 return ImmutableCompositeNode.create(notificationDef.get().getQName(), domNodes);
415 * Transforms XML Document representing Rpc output body into Composite Node structure based on Rpc definition
416 * within given Schema Context. The transformation is based on Rpc Definition which is defined in provided Schema Context.
417 * If Rpc Definition is missing from given Schema Context the method will return <code>null</code>
419 * @param document XML Document containing Output RPC message
420 * @param rpcName Rpc QName
421 * @param context Schema Context
422 * @return Rpc message in Composite Node data structures if Rpc definition is present within provided Schema Context, otherwise
423 * returns <code>null</code>
425 public static CompositeNode rpcReplyToDomNodes(final Document document, final QName rpcName,
426 final SchemaContext context) {
427 Preconditions.checkNotNull(document);
428 Preconditions.checkNotNull(rpcName);
429 Preconditions.checkNotNull(context);
431 Optional<RpcDefinition> rpcDefinition = findRpc(rpcName, context);
432 if (rpcDefinition.isPresent()) {
433 RpcDefinition rpc = rpcDefinition.get();
435 final Collection<DataSchemaNode> outputNode = rpc.getOutput().getChildNodes();
436 final Element rpcReplyElement = document.getDocumentElement();
437 final QName partialQName = qNameFromElement(rpcReplyElement);
439 if (RPC_REPLY_QNAME.equals(partialQName)) {
440 final List<Node<?>> domNodes = toDomNodes(rpcReplyElement, Optional.fromNullable(outputNode), context);
441 List<Node<?>> rpcOutNodes = Collections.<Node<?>>singletonList(ImmutableCompositeNode.create(
442 rpc.getOutput().getQName(), domNodes));
443 return ImmutableCompositeNode.create(rpcName, rpcOutNodes);
450 * Method searches given schema context for Rpc Definition with given QName.
451 * Returns Rpc Definition if is present within given Schema Context, otherwise returns Optional.absent().
453 * @param rpc Rpc QName
454 * @param context Schema Context
455 * @return Rpc Definition if is present within given Schema Context, otherwise returns Optional.absent().
457 private static Optional<RpcDefinition> findRpc(final QName rpc, final SchemaContext context) {
458 Preconditions.checkNotNull(rpc);
459 Preconditions.checkNotNull(context);
460 for (final RpcDefinition rpcDefinition : context.getOperations()) {
461 if ((rpcDefinition != null) && rpc.equals(rpcDefinition.getQName())) {
462 return Optional.of(rpcDefinition);
465 return Optional.absent();
468 public static CompositeNode notificationToDomNodes(final Document document,
469 final Optional<Set<NotificationDefinition>> notifications) {
470 return notificationToDomNodes(document, notifications,null);
473 private static Optional<NotificationDefinition> findNotification(final QName notifName,
474 final Set<NotificationDefinition> notifications) {
475 if ((notifName != null) && (notifications != null)) {
476 for (final NotificationDefinition notification : notifications) {
477 if ((notification != null) && notifName.isEqualWithoutRevision(notification.getQName())) {
478 return Optional.<NotificationDefinition>fromNullable(notification);
482 return Optional.<NotificationDefinition>absent();
485 private static final <T> List<T> forEachChild(final NodeList nodes, final SchemaContext schemaContext, final Function<ElementWithSchemaContext, Optional<T>> forBody) {
486 final int l = nodes.getLength();
488 return ImmutableList.of();
491 final List<T> list = new ArrayList<>(l);
492 for (int i = 0; i < l; i++) {
493 org.w3c.dom.Node child = nodes.item(i);
494 if (child instanceof Element) {
495 Optional<T> result = forBody.apply(new ElementWithSchemaContext((Element) child,schemaContext));
496 if (result.isPresent()) {
497 list.add(result.get());
501 return ImmutableList.copyOf(list);
504 public static final XmlCodecProvider defaultValueCodecProvider() {
505 return XmlUtils.DEFAULT_XML_CODEC_PROVIDER;