/*
* ============LICENSE_START=======================================================
* Copyright (C) 2022 Deutsche Telekom AG
+ * Modifications Copyright (C) 2023-2024 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.onap.cps.utils;
-
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.StringWriter;
+import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
-import org.onap.cps.spi.exceptions.DataValidationException;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class XmlFileUtils {
- private static DocumentBuilderFactory dbFactory = DocumentBuilderFactory.newInstance();
- private static final String DATA_ROOT_NODE_TAG_NAME = "data";
- private static final String ROOT_NODE_NAMESPACE = "urn:ietf:params:xml:ns:netconf:base:1.0";
- private static final Pattern XPATH_PROPERTY_REGEX = Pattern.compile(
- "\\[@(\\S{1,100})=['\\\"](\\S{1,100})['\\\"]\\]");
+ private static final DocumentBuilderFactory documentBuilderFactory = DocumentBuilderFactory.newInstance();
+ private static boolean isNewDocumentBuilderFactoryInstance = true;
+ private static final TransformerFactory transformerFactory = TransformerFactory.newInstance();
+ private static boolean isNewTransformerFactoryInstance = true;
+ private static final Pattern XPATH_PROPERTY_REGEX =
+ Pattern.compile("\\[@(\\S{1,100})=['\\\"](\\S{1,100})['\\\"]\\]");
/**
* Prepare XML content.
*
* @param xmlContent XML content sent to store
* @param schemaContext schema context
+ *
* @return XML content wrapped by root node (if needed)
*/
- public static String prepareXmlContent(final String xmlContent, final SchemaContext schemaContext) {
-
+ public static String prepareXmlContent(final String xmlContent, final SchemaContext schemaContext)
+ throws IOException, ParserConfigurationException, TransformerException, SAXException {
return addRootNodeToXmlContent(xmlContent, schemaContext.getModules().iterator().next().getName(),
- ROOT_NODE_NAMESPACE);
-
+ YangParserHelper.DATA_ROOT_NODE_NAMESPACE);
}
/**
*
* @param xmlContent XML content sent to store
* @param parentSchemaNode Parent schema node
+ * @param xpath Parent xpath
+ *
* @return XML content wrapped by root node (if needed)
*/
- public static String prepareXmlContent(final String xmlContent, final DataSchemaNode parentSchemaNode,
- final String xpath) {
+ public static String prepareXmlContent(final String xmlContent,
+ final DataSchemaNode parentSchemaNode,
+ final String xpath)
+ throws IOException, ParserConfigurationException, TransformerException, SAXException {
final String namespace = parentSchemaNode.getQName().getNamespace().toString();
final String parentXpathPart = xpath.substring(xpath.lastIndexOf('/') + 1);
final Matcher regexMatcher = XPATH_PROPERTY_REGEX.matcher(parentXpathPart);
if (regexMatcher.find()) {
- final HashMap<String, String> rootNodePropertyMap = new HashMap<String, String>();
+ final HashMap<String, String> rootNodePropertyMap = new HashMap<>();
rootNodePropertyMap.put(regexMatcher.group(1), regexMatcher.group(2));
return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace,
rootNodePropertyMap);
return addRootNodeToXmlContent(xmlContent, parentSchemaNode.getQName().getLocalName(), namespace);
}
- /**
- * Add root node to XML content.
- *
- * @param xmlContent xml content to add root node
- * @param rootNodeTagName root node tag name
- * @param namespace root node namespace
- * @param rootNodeProperty root node properites map
- * @return An edited content with added root node (if needed)
- */
- public static String addRootNodeToXmlContent(final String xmlContent, final String rootNodeTagName,
+ private static String addRootNodeToXmlContent(final String xmlContent,
+ final String rootNodeTagName,
final String namespace,
- final HashMap<String, String> rootNodeProperty) {
- try {
- final DocumentBuilder documentBuilder = dbFactory.newDocumentBuilder();
- final StringBuilder xmlStringBuilder = new StringBuilder();
- xmlStringBuilder.append(xmlContent);
- Document xmlDoc = documentBuilder.parse(
- new ByteArrayInputStream(xmlStringBuilder.toString().getBytes("utf-8")));
- final Element root = xmlDoc.getDocumentElement();
- if (!root.getTagName().equals(rootNodeTagName) && !root.getTagName().equals(DATA_ROOT_NODE_TAG_NAME)) {
- xmlDoc = addDataRootNode(root, rootNodeTagName, namespace, rootNodeProperty);
- xmlDoc.setXmlStandalone(true);
- final TransformerFactory transformerFactory = TransformerFactory.newInstance();
- transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
- transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
- final Transformer transformer = transformerFactory.newTransformer();
- final StringWriter stringWriter = new StringWriter();
- transformer.transform(new DOMSource(xmlDoc), new StreamResult(stringWriter));
- return stringWriter.toString();
- }
- return xmlContent;
- } catch (SAXException | IOException | ParserConfigurationException | TransformerException exception) {
- throw new DataValidationException("Failed to parse XML data", "Invalid xml input " + exception.getMessage(),
- exception);
+ final Map<String, String> rootNodeProperty)
+ throws IOException, SAXException, ParserConfigurationException, TransformerException {
+ final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
+ final Document document =
+ documentBuilder.parse(new ByteArrayInputStream(xmlContent.getBytes(StandardCharsets.UTF_8)));
+ final Element root = document.getDocumentElement();
+ if (!root.getTagName().equals(rootNodeTagName)
+ && !root.getTagName().equals(YangParserHelper.DATA_ROOT_NODE_TAG_NAME)) {
+ final Document documentWithRootNode = addDataRootNode(root, rootNodeTagName, namespace, rootNodeProperty);
+ documentWithRootNode.setXmlStandalone(true);
+ final Transformer transformer = getTransformerFactory().newTransformer();
+ final StringWriter stringWriter = new StringWriter();
+ transformer.transform(new DOMSource(documentWithRootNode), new StreamResult(stringWriter));
+ return stringWriter.toString();
}
+ return xmlContent;
}
/**
* @param rootNodeTagName Root node tag name
* @return XML content with root node tag added (if needed)
*/
- public static String addRootNodeToXmlContent(final String xmlContent, final String rootNodeTagName,
- final String namespace) {
- return addRootNodeToXmlContent(xmlContent, rootNodeTagName, namespace, new HashMap<String, String>());
+ public static String addRootNodeToXmlContent(final String xmlContent,
+ final String rootNodeTagName,
+ final String namespace)
+ throws IOException, ParserConfigurationException, TransformerException, SAXException {
+ return addRootNodeToXmlContent(xmlContent, rootNodeTagName, namespace, new HashMap<>());
}
/**
* @param tagName Root tag name to add
* @return DOM element with a root node
*/
- static Document addDataRootNode(final Element node, final String tagName, final String namespace,
- final HashMap<String, String> rootNodeProperty) {
- try {
- final DocumentBuilder docBuilder = dbFactory.newDocumentBuilder();
- final Document document = docBuilder.newDocument();
- final Element rootElement = document.createElementNS(namespace, tagName);
- for (final Map.Entry<String, String> entry : rootNodeProperty.entrySet()) {
- final Element propertyElement = document.createElement(entry.getKey());
- propertyElement.setTextContent(entry.getValue());
- rootElement.appendChild(propertyElement);
- }
- rootElement.appendChild(document.adoptNode(node));
- document.appendChild(rootElement);
- return document;
- } catch (final ParserConfigurationException exception) {
- throw new DataValidationException("Can't parse XML", "XML can't be parsed", exception);
+ static Document addDataRootNode(final Element node,
+ final String tagName,
+ final String namespace,
+ final Map<String, String> rootNodeProperty)
+ throws ParserConfigurationException {
+ final DocumentBuilder documentBuilder = getDocumentBuilderFactory().newDocumentBuilder();
+ final Document document = documentBuilder.newDocument();
+ final Element rootElement = document.createElementNS(namespace, tagName);
+ for (final Map.Entry<String, String> entry : rootNodeProperty.entrySet()) {
+ final Element propertyElement = document.createElement(entry.getKey());
+ propertyElement.setTextContent(entry.getValue());
+ rootElement.appendChild(propertyElement);
}
+ rootElement.appendChild(document.adoptNode(node));
+ document.appendChild(rootElement);
+ return document;
+ }
+
+ private static DocumentBuilderFactory getDocumentBuilderFactory() {
+
+ if (isNewDocumentBuilderFactoryInstance) {
+ documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
+ documentBuilderFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_SCHEMA, "");
+ isNewDocumentBuilderFactoryInstance = false;
+ }
+
+ return documentBuilderFactory;
+ }
+
+ private static TransformerFactory getTransformerFactory() {
+
+ if (isNewTransformerFactoryInstance) {
+ transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_DTD, "");
+ transformerFactory.setAttribute(XMLConstants.ACCESS_EXTERNAL_STYLESHEET, "");
+ isNewTransformerFactoryInstance = false;
+ }
+
+ return transformerFactory;
}
}