2 * Copyright (c) 2014, 2015 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
9 package org.opendaylight.controller.cluster.datastore.util;
11 import org.opendaylight.controller.cluster.datastore.node.utils.NodeIdentifierFactory;
12 import org.opendaylight.controller.cluster.datastore.node.utils.QNameFactory;
13 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.PathArgumentSerializer;
14 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.QNameDeSerializationContext;
15 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.QNameDeSerializationContextImpl;
16 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.QNameSerializationContext;
17 import org.opendaylight.controller.cluster.datastore.node.utils.serialization.QNameSerializationContextImpl;
18 import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages;
19 import org.opendaylight.controller.protobuff.messages.common.NormalizedNodeMessages.InstanceIdentifier.Builder;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
24 import java.util.ArrayList;
25 import java.util.HashMap;
26 import java.util.HashSet;
27 import java.util.List;
32 * This class contains utility methods for converting an MD-SAL
33 * YangInstanceIdentifier to and from other representations.
35 * The representations convered for now are,
39 * <li>Protocol Buffer</li>
42 public class InstanceIdentifierUtils {
44 protected static final Logger logger = LoggerFactory
45 .getLogger(InstanceIdentifierUtils.class);
48 * Convert an MD-SAL YangInstanceIdentifier into a protocol buffer version of it
50 * @param path an MD-SAL YangInstanceIdentifier
51 * @return a protocol buffer version of the MD-SAL YangInstanceIdentifier
53 public static NormalizedNodeMessages.InstanceIdentifier toSerializable(YangInstanceIdentifier path) {
54 QNameSerializationContextImpl context = new QNameSerializationContextImpl();
55 Builder builder = toSerializableBuilder(path, context);
56 return builder.addAllCode(context.getCodes()).build();
59 public static NormalizedNodeMessages.InstanceIdentifier toSerializable(
60 YangInstanceIdentifier path, QNameSerializationContext context) {
61 return toSerializableBuilder(path, context).build();
64 private static NormalizedNodeMessages.InstanceIdentifier.Builder toSerializableBuilder(
65 YangInstanceIdentifier path, QNameSerializationContext context) {
66 NormalizedNodeMessages.InstanceIdentifier.Builder builder =
67 NormalizedNodeMessages.InstanceIdentifier.newBuilder();
70 for (org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.
71 PathArgument pathArgument : path.getPathArguments()) {
72 NormalizedNodeMessages.PathArgument serializablePathArgument;
75 if(!(pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier)){
76 nodeType = pathArgument.getNodeType().toString();
79 serializablePathArgument = NormalizedNodeMessages.PathArgument.newBuilder()
80 .setValue(pathArgument.toString())
81 .setType(pathArgument.getClass().getSimpleName())
82 .setNodeType(NormalizedNodeMessages.QName.newBuilder().setValue(nodeType))
83 .addAllAttributes(getPathArgumentAttributes(pathArgument)).build();
85 serializablePathArgument = PathArgumentSerializer.serialize(context, pathArgument);
88 builder.addArguments(serializablePathArgument);
91 logger.error("An exception occurred", e);
99 * Convert a protocol buffer version of the MD-SAL YangInstanceIdentifier into
100 * the MD-SAL version of the YangInstanceIdentifier
102 * @param path a protocol buffer version of the MD-SAL YangInstanceIdentifier
103 * @return an MD-SAL YangInstanceIdentifier
105 public static YangInstanceIdentifier fromSerializable(NormalizedNodeMessages.InstanceIdentifier path) {
106 return fromSerializable(path, new QNameDeSerializationContextImpl(path.getCodeList()));
109 public static YangInstanceIdentifier fromSerializable(NormalizedNodeMessages.InstanceIdentifier path,
110 QNameDeSerializationContext context) {
112 List<YangInstanceIdentifier.PathArgument> pathArguments = new ArrayList<>();
114 for(NormalizedNodeMessages.PathArgument pathArgument : path.getArgumentsList()) {
115 if(context == null || pathArgument.hasType()) {
116 pathArguments.add(parsePathArgument(pathArgument));
118 pathArguments.add(PathArgumentSerializer.deSerialize(context, pathArgument));
122 return YangInstanceIdentifier.create(pathArguments);
126 * Take the various attributes of a PathArgument and package them up as
127 * protocol buffer attributes.
130 * PathArguments have 4 subtypes and each of the various subtypes have
131 * different attributes
134 * NodeIdentifier is the most basic PathArgument. It is used for
135 * ContainerNode, LeafNode etc and has no attributes
138 * NodeWithValue has only a single attribute. It is used for
139 * LeafListEntryNodes and the attribute it contains is the value
143 * NodeIdentifierWithPredicates has a map of attributes.
144 * It is used to represent a ListItemNode. Each entry
145 * in the map of attributes represents the key and value of the
146 * keys in that entry.
149 * AugmentationIdentifier has a list of unnamed attributes. Each
150 * attribute represents the possible children that can go within
151 * an augmentation entry.
154 * @param pathArgument
157 private static Iterable<? extends NormalizedNodeMessages.Attribute> getPathArgumentAttributes(
158 YangInstanceIdentifier.PathArgument pathArgument) {
159 List<NormalizedNodeMessages.Attribute> attributes = new ArrayList<>();
163 if (pathArgument instanceof YangInstanceIdentifier.NodeWithValue) {
164 YangInstanceIdentifier.NodeWithValue identifier
165 = (YangInstanceIdentifier.NodeWithValue) pathArgument;
167 NormalizedNodeMessages.Attribute attribute =
168 NormalizedNodeMessages.Attribute.newBuilder()
170 .setValue(identifier.getValue().toString())
171 .setType(identifier.getValue().getClass().getSimpleName())
174 attributes.add(attribute);
175 } else if (pathArgument instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) {
176 YangInstanceIdentifier.NodeIdentifierWithPredicates identifier
177 = (YangInstanceIdentifier.NodeIdentifierWithPredicates) pathArgument;
179 for (QName key : identifier.getKeyValues().keySet()) {
180 Object value = identifier.getKeyValues().get(key);
181 NormalizedNodeMessages.Attribute attribute =
182 NormalizedNodeMessages.Attribute.newBuilder()
183 .setName(key.toString())
184 .setValue(value.toString())
185 .setType(value.getClass().getSimpleName())
188 attributes.add(attribute);
192 } else if(pathArgument instanceof YangInstanceIdentifier.AugmentationIdentifier) {
193 YangInstanceIdentifier.AugmentationIdentifier identifier
194 = (YangInstanceIdentifier.AugmentationIdentifier) pathArgument;
196 for (QName key : identifier.getPossibleChildNames()) {
198 NormalizedNodeMessages.Attribute attribute =
199 NormalizedNodeMessages.Attribute.newBuilder()
200 .setName(key.toString())
201 .setValue(value.toString())
202 .setType(value.getClass().getSimpleName())
205 attributes.add(attribute);
215 * Parse a protocol buffer PathArgument and return an MD-SAL PathArgument
217 * @param pathArgument protocol buffer PathArgument
218 * @return MD-SAL PathArgument
220 private static YangInstanceIdentifier.PathArgument parsePathArgument(
221 NormalizedNodeMessages.PathArgument pathArgument) {
222 if (YangInstanceIdentifier.NodeWithValue.class.getSimpleName().equals(pathArgument.getType())) {
224 YangInstanceIdentifier.NodeWithValue nodeWithValue =
225 new YangInstanceIdentifier.NodeWithValue(
226 QNameFactory.create(pathArgument.getNodeType().getValue()),
227 parseAttribute(pathArgument.getAttributes(0)));
229 return nodeWithValue;
231 } else if(YangInstanceIdentifier.NodeIdentifierWithPredicates.class.getSimpleName().equals(pathArgument.getType())){
233 YangInstanceIdentifier.NodeIdentifierWithPredicates
234 nodeIdentifierWithPredicates =
235 new YangInstanceIdentifier.NodeIdentifierWithPredicates(
236 QNameFactory.create(pathArgument.getNodeType().getValue()), toAttributesMap(pathArgument.getAttributesList()));
238 return nodeIdentifierWithPredicates;
240 } else if(YangInstanceIdentifier.AugmentationIdentifier.class.getSimpleName().equals(pathArgument.getType())){
242 Set<QName> qNameSet = new HashSet<>();
244 for(NormalizedNodeMessages.Attribute attribute : pathArgument.getAttributesList()){
245 qNameSet.add(QNameFactory.create(attribute.getValue()));
248 return new YangInstanceIdentifier.AugmentationIdentifier(qNameSet);
251 return NodeIdentifierFactory.getArgument(pathArgument.getValue());
254 private static Map<QName, Object> toAttributesMap(
255 List<NormalizedNodeMessages.Attribute> attributesList) {
257 Map<QName, Object> map = new HashMap<>();
259 for(NormalizedNodeMessages.Attribute attribute : attributesList){
260 String name = attribute.getName();
261 Object value = parseAttribute(attribute);
263 map.put(QNameFactory.create(name), value);
270 * FIXME: This method only covers a subset of values that may go in an InstanceIdentifier
275 private static Object parseAttribute(NormalizedNodeMessages.Attribute attribute){
276 if(Short.class.getSimpleName().equals(attribute.getType())) {
277 return Short.parseShort(attribute.getValue());
278 } else if(Long.class.getSimpleName().equals(attribute.getType())){
279 return Long.parseLong(attribute.getValue());
280 } else if(Boolean.class.getSimpleName().equals(attribute.getType())){
281 return Boolean.parseBoolean(attribute.getValue());
282 } else if(Integer.class.getSimpleName().equals(attribute.getType())){
283 return Integer.parseInt(attribute.getValue());
286 return attribute.getValue();