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.netconf.util;
10 import com.google.common.base.Preconditions;
11 import java.io.IOException;
12 import java.net.URISyntaxException;
13 import java.util.Iterator;
14 import javax.xml.parsers.ParserConfigurationException;
15 import javax.xml.stream.XMLOutputFactory;
16 import javax.xml.stream.XMLStreamException;
17 import javax.xml.stream.XMLStreamWriter;
18 import javax.xml.transform.dom.DOMResult;
19 import javax.xml.transform.dom.DOMSource;
20 import org.opendaylight.netconf.api.DocumentedException;
21 import org.opendaylight.netconf.api.xml.XmlElement;
22 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
23 import org.opendaylight.netconf.api.xml.XmlUtil;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
29 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
30 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
31 import org.opendaylight.yangtools.yang.data.codec.xml.XmlCodecFactory;
32 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
33 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
34 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
35 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
37 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
40 import org.w3c.dom.Document;
41 import org.xml.sax.SAXException;
43 public final class NetconfUtil {
45 public static final QName NETCONF_QNAME =
46 QName.create("urn:ietf:params:xml:ns:netconf:base:1.0", "2011-06-01", "netconf").intern();
47 public static final QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data").intern();
48 public static final XMLOutputFactory XML_FACTORY;
50 private static final Logger LOG = LoggerFactory.getLogger(NetconfUtil.class);
53 XML_FACTORY = XMLOutputFactory.newFactory();
54 XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
57 private NetconfUtil() {
61 public static Document checkIsMessageOk(final Document response) throws DocumentedException {
62 XmlElement element = XmlElement.fromDomDocument(response);
63 Preconditions.checkState(element.getName().equals(XmlNetconfConstants.RPC_REPLY_KEY));
64 element = element.getOnlyChildElement();
65 if (element.getName().equals(XmlNetconfConstants.OK)) {
68 LOG.warn("Can not load last configuration. Operation failed.");
69 throw new IllegalStateException("Can not load last configuration. Operation failed: "
70 + XmlUtil.toString(response));
73 @SuppressWarnings("checkstyle:IllegalCatch")
74 public static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result,
75 final SchemaPath schemaPath, final SchemaContext context)
76 throws IOException, XMLStreamException {
77 final XMLStreamWriter writer = XML_FACTORY.createXMLStreamWriter(result);
79 NormalizedNodeStreamWriter normalizedNodeStreamWriter =
80 XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
81 NormalizedNodeWriter normalizedNodeWriter =
82 NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter)
84 normalizedNodeWriter.write(normalized);
85 normalizedNodeWriter.flush();
91 } catch (final Exception e) {
92 LOG.warn("Unable to close resource properly", e);
97 public static void writeFilter(final YangInstanceIdentifier query, final DOMResult result,
98 final SchemaPath schemaPath, final SchemaContext context) throws IOException, XMLStreamException {
99 if (query.isEmpty()) {
104 final XMLStreamWriter xmlWriter = XML_FACTORY.createXMLStreamWriter(result);
106 try (NormalizedNodeStreamWriter writer =
107 XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, context, schemaPath)) {
108 final Iterator<PathArgument> it = query.getPathArguments().iterator();
109 final PathArgument first = it.next();
110 StreamingContext.fromSchemaAndQNameChecked(context, first.getNodeType()).streamToWriter(writer, first,
118 public static NormalizedNodeResult transformDOMSourceToNormalizedNode(final SchemaContext schemaContext,
119 final DOMSource value) throws XMLStreamException, URISyntaxException, IOException, SAXException,
120 ParserConfigurationException {
121 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
122 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
123 final XmlCodecFactory codecs = XmlCodecFactory.create(schemaContext);
124 final ContainerSchemaNode dataRead = new NodeContainerProxy(NETCONF_DATA_QNAME, schemaContext.getChildNodes());
125 try (XmlParserStream xmlParserStream = XmlParserStream.create(writer, codecs, dataRead)) {
126 xmlParserStream.traverse(value);