2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.ccsdk.sli.plugins.yangserializers.dfserializer;
23 import org.dom4j.Element;
24 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
25 import org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.Namespace;
26 import org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.PropertiesNode;
27 import org.opendaylight.yangtools.yang.model.api.Module;
28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
29 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
30 import org.w3c.dom.Document;
31 import org.xml.sax.InputSource;
32 import org.xml.sax.SAXException;
34 import javax.xml.parsers.DocumentBuilder;
35 import javax.xml.parsers.DocumentBuilderFactory;
36 import javax.xml.parsers.ParserConfigurationException;
37 import javax.xml.transform.Transformer;
38 import javax.xml.transform.TransformerException;
39 import javax.xml.transform.TransformerFactory;
40 import javax.xml.transform.dom.DOMSource;
41 import javax.xml.transform.stream.StreamResult;
42 import java.io.IOException;
43 import java.io.StringReader;
44 import java.io.StringWriter;
45 import java.io.Writer;
47 import java.net.URISyntaxException;
48 import java.util.Iterator;
50 import static javax.xml.transform.OutputKeys.INDENT;
51 import static org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.XmlNodeType.OBJECT_NODE;
52 import static org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.XmlNodeType.TEXT_NODE;
53 import static org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.MdsalPropertiesNodeUtils.getRevision;
56 * Utilities for data format serializer.
58 public final class DfSerializerUtil {
60 static final String JSON_WRITE_ERR = "Unable to write to JSON from " +
63 static final String NODE_TYPE_ERR = "The node type %s is not supported.";
65 static final String JSON_LIS_ERR = "The JSON serializer doesn't have " +
68 static final String XML_LIS_ERR = "The XML serializer doesn't have XML " +
71 static final String PROP_NODE_ERR = "The property node doesn't have " +
72 "schema node bound to it.";
74 static final String DF_ERR = "Type mismatch for the node %s. The schema " +
75 "node does not match with the data format node type %s.";
77 static final String XML_PREFIX = "yangid";
79 private static final String YES = "yes";
81 private static final String INDENT_XMLNS = "{http://xml.apache" +
82 ".org/xslt}indent-amount";
84 private static final String XML_PARSE_ERR = "Unable to parse the xml to " +
87 private static final String URI_ERR = "Unable to parse the URI";
90 * Data format error message for unsupported types.
92 public static final String FORMAT_ERR = "Only JSON and XML formats are " +
93 "supported. %s is not supported";
96 * UTF header message for XML data format message.
98 public static final String UTF_HEADER = "<?xml version=\"1.0\" " +
99 "encoding=\"UTF-8\"?>";
102 * Error message when a JSON tree creation fails.
104 public static final String JSON_TREE_ERR = "Unable to form JSON tree " +
105 "object from the JSON body provided.";
108 * Error message when a XML tree creation fails.
110 public static final String XML_TREE_ERR = "Unable to form XML tree object" +
111 " from the XML body provided.";
114 private DfSerializerUtil() {
118 * Returns the writer which contains the pretty formatted XML string.
120 * @param input input XML
121 * @param indent indentation level
122 * @return writer with XML
123 * @throws SvcLogicException when transformation of source fails
125 public static Writer getXmlWriter(String input, String indent)
126 throws SvcLogicException {
128 Transformer transformer = TransformerFactory.newInstance()
130 transformer.setOutputProperty(INDENT, YES);
131 transformer.setOutputProperty(INDENT_XMLNS, indent);
132 StreamResult result = new StreamResult(new StringWriter());
133 DOMSource source = new DOMSource(parseXml(input));
134 transformer.transform(source, result);
135 return result.getWriter();
136 } catch (TransformerException e) {
137 throw new SvcLogicException(XML_PARSE_ERR + input, e);
142 * Parses the XML and converts it into dom document which can be used for
143 * formatting the XML.
145 * @param in input XML
146 * @return dom document of XML
147 * @throws SvcLogicException when document building fails
149 private static Document parseXml(String in) throws SvcLogicException {
150 DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
153 db = dbf.newDocumentBuilder();
154 InputSource is = new InputSource(new StringReader(in));
156 } catch (SAXException | IOException | ParserConfigurationException e) {
157 throw new SvcLogicException(XML_PARSE_ERR + in, e);
162 * Returns the resolved namespace object from the input received from the
163 * abstract data format.
165 * @param mName module name
166 * @param mUri module URI
167 * @param ctx schema context
168 * @param parent parent properties node
170 * @throws SvcLogicException when resolving namespace fails
172 static Namespace getResolvedNamespace(String mName, String mUri,
174 PropertiesNode parent)
175 throws SvcLogicException {
176 if (mName == null && mUri == null) {
177 Namespace parentNs = parent.namespace();
178 return new Namespace(parentNs.moduleName(), parentNs.moduleNs(),
179 parentNs.revision());
185 it = ctx.findModules(mName).iterator();
189 modUri = new URI(mUri);
190 } catch (URISyntaxException e) {
191 throw new SvcLogicException(URI_ERR, e);
193 it = ctx.findModules(modUri).iterator();
201 return new Namespace(mod.getName(), mod.getQNameModule().getNamespace(),
202 getRevision(mod.getRevision()));
206 * Returns the node type of a XML element.
208 * @param element XML element
209 * @return node type of the XML element
211 static XmlNodeType getXmlNodeType(Element element) {
212 Element newElement = element.createCopy();
213 newElement.remove(element.getNamespace());
214 return newElement.hasContent() && newElement.isTextOnly() ?
215 TEXT_NODE : OBJECT_NODE;
219 * Resolves the super type to the base type from type definition.
221 * @param type super type
222 * @return base type definition
224 static TypeDefinition<?> resolveBaseTypeFrom(TypeDefinition<?> type) {
225 TypeDefinition superType = type;
226 while (superType.getBaseType() != null) {
227 superType = superType.getBaseType();