X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fnetconf%2Fnetconf-util%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fnetconf%2Futil%2Fxml%2FXmlUtil.java;h=ee5b27b2e7c704fc2531899b41241cb10f8ab15d;hp=238249dbbd8d49086b38c1696cb6d0cb685909fe;hb=5834d6db8a5b2f56ec469ceafd899a94a69f7b91;hpb=efa5be8f930f3eda7094c314e22347868b9db173 diff --git a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/xml/XmlUtil.java b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/xml/XmlUtil.java index 238249dbbd..ee5b27b2e7 100644 --- a/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/xml/XmlUtil.java +++ b/opendaylight/netconf/netconf-util/src/main/java/org/opendaylight/controller/netconf/util/xml/XmlUtil.java @@ -8,13 +8,14 @@ package org.opendaylight.controller.netconf.util.xml; +import com.google.common.base.Charsets; +import com.google.common.base.Optional; import java.io.ByteArrayInputStream; import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.InputStream; import java.io.StringWriter; - import javax.xml.XMLConstants; import javax.xml.namespace.QName; import javax.xml.parsers.DocumentBuilder; @@ -23,7 +24,6 @@ import javax.xml.parsers.ParserConfigurationException; import javax.xml.transform.OutputKeys; import javax.xml.transform.Source; import javax.xml.transform.Transformer; -import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; import javax.xml.transform.TransformerFactoryConfigurationError; import javax.xml.transform.dom.DOMSource; @@ -33,18 +33,19 @@ import javax.xml.validation.Schema; import javax.xml.validation.SchemaFactory; import javax.xml.xpath.XPathExpression; import javax.xml.xpath.XPathExpressionException; - +import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; import org.xml.sax.SAXException; -import com.google.common.base.Charsets; - public final class XmlUtil { public static final String XMLNS_ATTRIBUTE_KEY = "xmlns"; - private static final DocumentBuilderFactory BUILDERFACTORY; + public static final String XMLNS_URI = "http://www.w3.org/2000/xmlns/"; + private static final DocumentBuilderFactory BUILDER_FACTORY; + private static final TransformerFactory TRANSFORMER_FACTORY = TransformerFactory.newInstance(); + private static final SchemaFactory SCHEMA_FACTORY = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); static { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); @@ -52,34 +53,36 @@ public final class XmlUtil { factory.setCoalescing(true); factory.setIgnoringElementContentWhitespace(true); factory.setIgnoringComments(true); - BUILDERFACTORY = factory; + BUILDER_FACTORY = factory; } - private XmlUtil() {} + private XmlUtil() { + throw new UnsupportedOperationException("Utility class"); + } - public static Element readXmlToElement(String xmlContent) throws SAXException, IOException { + public static Element readXmlToElement(final String xmlContent) throws SAXException, IOException { Document doc = readXmlToDocument(xmlContent); return doc.getDocumentElement(); } - public static Element readXmlToElement(InputStream xmlContent) throws SAXException, IOException { + public static Element readXmlToElement(final InputStream xmlContent) throws SAXException, IOException { Document doc = readXmlToDocument(xmlContent); return doc.getDocumentElement(); } - public static Document readXmlToDocument(String xmlContent) throws SAXException, IOException { + public static Document readXmlToDocument(final String xmlContent) throws SAXException, IOException { return readXmlToDocument(new ByteArrayInputStream(xmlContent.getBytes(Charsets.UTF_8))); } // TODO improve exceptions throwing // along with XmlElement - public static Document readXmlToDocument(InputStream xmlContent) throws SAXException, IOException { + public static Document readXmlToDocument(final InputStream xmlContent) throws SAXException, IOException { DocumentBuilder dBuilder; try { - dBuilder = BUILDERFACTORY.newDocumentBuilder(); + dBuilder = BUILDER_FACTORY.newDocumentBuilder(); } catch (ParserConfigurationException e) { - throw new RuntimeException("Failed to parse XML document", e); + throw new IllegalStateException("Failed to parse XML document", e); } Document doc = dBuilder.parse(xmlContent); @@ -87,57 +90,73 @@ public final class XmlUtil { return doc; } - public static Element readXmlToElement(File xmlFile) throws SAXException, IOException { + public static Element readXmlToElement(final File xmlFile) throws SAXException, IOException { return readXmlToDocument(new FileInputStream(xmlFile)).getDocumentElement(); } public static Document newDocument() { try { - DocumentBuilder builder = BUILDERFACTORY.newDocumentBuilder(); - Document document = builder.newDocument(); - return document; + DocumentBuilder builder = BUILDER_FACTORY.newDocumentBuilder(); + return builder.newDocument(); } catch (ParserConfigurationException e) { - throw new RuntimeException("Failed to create document", e); + throw new IllegalStateException("Failed to create document", e); } } - public static Element createTextElement(Document document, String name, String content) { - Element typeElement = document.createElement(name); + public static Element createElement(final Document document, final String qName, final Optional namespaceURI) { + if(namespaceURI.isPresent()) { + final Element element = document.createElementNS(namespaceURI.get(), qName); + String name = XMLNS_ATTRIBUTE_KEY; + if(element.getPrefix() != null) { + name += ":" + element.getPrefix(); + } + element.setAttributeNS(XMLNS_URI, name, namespaceURI.get()); + return element; + } + return document.createElement(qName); + } + + public static Element createTextElement(final Document document, final String qName, final String content, final Optional namespaceURI) { + Element typeElement = createElement(document, qName, namespaceURI); typeElement.appendChild(document.createTextNode(content)); return typeElement; } - public static void addNamespaceAttr(Element root, String namespace) { - root.setAttribute(XMLNS_ATTRIBUTE_KEY, namespace); - } + public static Element createTextElementWithNamespacedContent(final Document document, final String qName, final String prefix, + final String namespace, final String contentWithoutPrefix) { - public static void addPrefixedNamespaceAttr(Element root, String prefix, String namespace) { - root.setAttribute(concat(XMLNS_ATTRIBUTE_KEY, prefix), namespace); + return createTextElementWithNamespacedContent(document, qName, prefix, namespace, contentWithoutPrefix, Optional.absent()); } - public static Element createPrefixedTextElement(Document document, String key, String prefix, String content) { - return createTextElement(document, key, concat(prefix, content)); + public static Element createTextElementWithNamespacedContent(final Document document, final String qName, final String prefix, + final String namespace, final String contentWithoutPrefix, final Optional namespaceURI) { + + String content = createPrefixedValue(XmlNetconfConstants.PREFIX, contentWithoutPrefix); + Element element = createTextElement(document, qName, content, namespaceURI); + String prefixedNamespaceAttr = createPrefixedValue(XMLNS_ATTRIBUTE_KEY, prefix); + element.setAttributeNS(XMLNS_URI, prefixedNamespaceAttr, namespace); + return element; } - private static String concat(String prefix, String value) { + public static String createPrefixedValue(final String prefix, final String value) { return prefix + ":" + value; } - public static String toString(Document document) { + public static String toString(final Document document) { return toString(document.getDocumentElement()); } - public static String toString(Element xml) { + public static String toString(final Element xml) { return toString(xml, false); } - public static String toString(XmlElement xmlElement) { + public static String toString(final XmlElement xmlElement) { return toString(xmlElement.getDomElement(), false); } - public static String toString(Element xml, boolean addXmlDeclaration) { + public static String toString(final Element xml, final boolean addXmlDeclaration) { try { - Transformer transformer = TransformerFactory.newInstance().newTransformer(); + Transformer transformer = TRANSFORMER_FACTORY.newTransformer(); transformer.setOutputProperty(OutputKeys.INDENT, "yes"); transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, addXmlDeclaration ? "no" : "yes"); @@ -146,31 +165,30 @@ public final class XmlUtil { transformer.transform(source, result); return result.getWriter().toString(); - } catch (IllegalArgumentException | TransformerFactoryConfigurationError | TransformerException e) { - throw new RuntimeException("Unable to serialize xml element " + xml, e); + } catch (Exception | TransformerFactoryConfigurationError e) { + throw new IllegalStateException("Unable to serialize xml element " + xml, e); } } - public static String toString(Document doc, boolean addXmlDeclaration) { + public static String toString(final Document doc, final boolean addXmlDeclaration) { return toString(doc.getDocumentElement(), addXmlDeclaration); } - public static Schema loadSchema(InputStream... fromStreams) { + public static Schema loadSchema(final InputStream... fromStreams) { Source[] sources = new Source[fromStreams.length]; int i = 0; for (InputStream stream : fromStreams) { sources[i++] = new StreamSource(stream); } - final SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI); try { - return schemaFactory.newSchema(sources); + return SCHEMA_FACTORY.newSchema(sources); } catch (SAXException e) { throw new IllegalStateException("Failed to instantiate XML schema", e); } } - public static Object evaluateXPath(XPathExpression expr, Object rootNode, QName returnType) { + public static Object evaluateXPath(final XPathExpression expr, final Object rootNode, final QName returnType) { try { return expr.evaluate(rootNode, returnType); } catch (XPathExpressionException e) { @@ -178,7 +196,7 @@ public final class XmlUtil { } } - public static Document createDocumentCopy(Document original) { + public static Document createDocumentCopy(final Document original) { final Document copiedDocument = newDocument(); final Node copiedRoot = copiedDocument.importNode(original.getDocumentElement(), true); copiedDocument.appendChild(copiedRoot);