2 * ============LICENSE_START=======================================================
3 * Copyright (C) 2020 Nordix Foundation
4 * ================================================================================
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 * SPDX-License-Identifier: Apache-2.0
17 * ============LICENSE_END=========================================================
20 package org.onap.cps.utils;
22 import com.google.gson.stream.JsonReader;
23 import java.io.IOException;
24 import java.io.StringReader;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.List;
28 import java.util.logging.Logger;
29 import java.util.stream.Collectors;
30 import org.onap.cps.api.impl.Fragment;
31 import org.opendaylight.yangtools.yang.common.QName;
32 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
33 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
34 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
41 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactory;
42 import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodecFactorySupplier;
43 import org.opendaylight.yangtools.yang.data.codec.gson.JsonParserStream;
44 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
45 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
46 import org.opendaylight.yangtools.yang.model.api.Module;
47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
49 public class YangUtils {
50 private static final Logger LOGGER = Logger.getLogger(YangUtils.class.getName());
53 throw new IllegalStateException("Utility class");
57 * Parse a string containing json data for a certain model (schemaContext).
59 * @param jsonData a string containing json data for the given model
60 * @param schemaContext the SchemaContext for the given data
61 * @return the NormalizedNode representing the json data
63 public static NormalizedNode<?, ?> parseJsonData(final String jsonData, final SchemaContext schemaContext)
65 final JSONCodecFactory jsonCodecFactory = JSONCodecFactorySupplier.DRAFT_LHOTKA_NETMOD_YANG_JSON_02
66 .getShared(schemaContext);
67 final NormalizedNodeResult normalizedNodeResult = new NormalizedNodeResult();
68 final NormalizedNodeStreamWriter normalizedNodeStreamWriter = ImmutableNormalizedNodeStreamWriter
69 .from(normalizedNodeResult);
70 try (final JsonParserStream jsonParserStream = JsonParserStream
71 .create(normalizedNodeStreamWriter, jsonCodecFactory)) {
72 final JsonReader jsonReader = new JsonReader(new StringReader(jsonData));
73 jsonParserStream.parse(jsonReader);
75 return normalizedNodeResult.getResult();
79 * Break a Normalized Node tree into fragments that can be stored by the persistence service.
81 * @param tree the normalized node tree
82 * @param module the module applicable for the data in the normalized node
83 * @return the 'root' Fragment for the tree contain all relevant children etc.
85 public static Fragment fragmentNormalizedNode(
86 final NormalizedNode<? extends YangInstanceIdentifier.PathArgument, ?> tree,
87 final Module module) {
88 final QName[] nodeTypes = {tree.getNodeType()};
89 final String xpath = buildXpathId(tree.getIdentifier());
90 final Fragment rootFragment = Fragment.createRootFragment(module, nodeTypes, xpath);
91 fragmentNormalizedNode(rootFragment, tree);
95 private static void fragmentNormalizedNode(final Fragment currentFragment,
96 final NormalizedNode normalizedNode) {
97 if (normalizedNode instanceof DataContainerNode) {
98 inspectContainer(currentFragment, (DataContainerNode) normalizedNode);
99 } else if (normalizedNode instanceof MapNode) {
100 inspectKeyedList(currentFragment, (MapNode) normalizedNode);
101 } else if (normalizedNode instanceof ValueNode) {
102 inspectLeaf(currentFragment, (ValueNode) normalizedNode);
103 } else if (normalizedNode instanceof LeafSetNode) {
104 inspectLeafList(currentFragment, (LeafSetNode) normalizedNode);
106 LOGGER.warning("Cannot normalize " + normalizedNode.getClass());
110 private static void inspectLeaf(final Fragment currentFragment,
111 final ValueNode valueNode) {
112 final Object value = valueNode.getValue();
113 currentFragment.addLeafValue(valueNode.getNodeType().getLocalName(), value);
116 private static void inspectLeafList(final Fragment currentFragment,
117 final LeafSetNode leafSetNode) {
118 currentFragment.addLeafListName(leafSetNode.getNodeType().getLocalName());
119 for (final NormalizedNode value : (Collection<NormalizedNode>) leafSetNode.getValue()) {
120 fragmentNormalizedNode(currentFragment, value);
124 private static void inspectContainer(final Fragment currentFragment,
125 final DataContainerNode dataContainerNode) {
126 final Collection<NormalizedNode> leaves = (Collection) dataContainerNode.getValue();
127 for (final NormalizedNode leaf : leaves) {
128 fragmentNormalizedNode(currentFragment, leaf);
132 private static void inspectKeyedList(final Fragment currentFragment,
133 final MapNode mapNode) {
134 createNodeForEachListElement(currentFragment, mapNode);
137 private static void createNodeForEachListElement(final Fragment currentFragment, final MapNode mapNode) {
138 final Collection<MapEntryNode> mapEntryNodes = mapNode.getValue();
139 for (final MapEntryNode mapEntryNode : mapEntryNodes) {
140 final String xpathId = buildXpathId(mapEntryNode.getIdentifier());
141 final Fragment listElementFragment =
142 currentFragment.createChildFragment(mapNode.getNodeType(), xpathId);
143 fragmentNormalizedNode(listElementFragment, mapEntryNode);
147 private static String buildXpathId(final YangInstanceIdentifier.PathArgument nodeIdentifier) {
148 final StringBuilder xpathIdBuilder = new StringBuilder();
149 xpathIdBuilder.append("/").append(nodeIdentifier.getNodeType().getLocalName());
151 if (nodeIdentifier instanceof NodeIdentifierWithPredicates) {
152 xpathIdBuilder.append(getKeyAttributesStatement((NodeIdentifierWithPredicates) nodeIdentifier));
154 return xpathIdBuilder.toString();
157 private static String getKeyAttributesStatement(final NodeIdentifierWithPredicates nodeIdentifier) {
158 final List<String> keyAttributes = nodeIdentifier.entrySet().stream().map(
160 final String name = entry.getKey().getLocalName();
161 final String value = String.valueOf(entry.getValue()).replace("'", "\\'");
162 return String.format("@%s='%s'", name, value);
164 ).collect(Collectors.toList());
166 if (keyAttributes.isEmpty()) {
169 Collections.sort(keyAttributes);
170 return "[" + String.join(" and ", keyAttributes) + "]";