Merge "Bug 1125: Added regression test"
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / restconf / impl / RestCodec.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.sal.restconf.impl;
9
10 import java.net.URI;
11 import java.util.ArrayList;
12 import java.util.HashMap;
13 import java.util.List;
14 import java.util.Map;
15 import org.opendaylight.controller.sal.core.api.mount.MountInstance;
16 import org.opendaylight.controller.sal.rest.impl.RestUtil;
17 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue;
18 import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate;
19 import org.opendaylight.yangtools.concepts.Codec;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
24 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeWithValue;
25 import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
26 import org.opendaylight.yangtools.yang.data.api.codec.IdentityrefCodec;
27 import org.opendaylight.yangtools.yang.data.api.codec.InstanceIdentifierCodec;
28 import org.opendaylight.yangtools.yang.data.api.codec.LeafrefCodec;
29 import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.Module;
35 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
36 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
37 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
38 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41
42 public class RestCodec {
43
44     private static final Logger logger = LoggerFactory.getLogger(RestCodec.class);
45
46     private RestCodec() {
47     }
48
49     public static final Codec<Object, Object> from(final TypeDefinition<?> typeDefinition,
50             final MountInstance mountPoint) {
51         return new ObjectCodec(typeDefinition, mountPoint);
52     }
53
54     @SuppressWarnings("rawtypes")
55     public static final class ObjectCodec implements Codec<Object, Object> {
56
57         private final Logger logger = LoggerFactory.getLogger(RestCodec.class);
58
59         public static final Codec LEAFREF_DEFAULT_CODEC = new LeafrefCodecImpl();
60         private final Codec instanceIdentifier;
61         private final Codec identityrefCodec;
62
63         private final TypeDefinition<?> type;
64
65         private ObjectCodec(final TypeDefinition<?> typeDefinition, final MountInstance mountPoint) {
66             type = RestUtil.resolveBaseTypeFrom(typeDefinition);
67             if (type instanceof IdentityrefTypeDefinition) {
68                 identityrefCodec = new IdentityrefCodecImpl(mountPoint);
69             } else {
70                 identityrefCodec = null;
71             }
72             if (type instanceof InstanceIdentifierTypeDefinition) {
73                 instanceIdentifier = new InstanceIdentifierCodecImpl(mountPoint);
74             } else {
75                 instanceIdentifier = null;
76             }
77         }
78
79         @SuppressWarnings("unchecked")
80         @Override
81         public Object deserialize(final Object input) {
82             try {
83                 if (type instanceof IdentityrefTypeDefinition) {
84                     if (input instanceof IdentityValuesDTO) {
85                         return identityrefCodec.deserialize(input);
86                     }
87                     logger.info(
88                             "Value is not instance of IdentityrefTypeDefinition but is {}. Therefore NULL is used as translation of  - {}",
89                             input == null ? "null" : input.getClass(), String.valueOf(input));
90                     return null;
91                 } else if (type instanceof LeafrefTypeDefinition) {
92                     if (input instanceof IdentityValuesDTO) {
93                         return LEAFREF_DEFAULT_CODEC.deserialize(((IdentityValuesDTO) input).getOriginValue());
94                     }
95                     return LEAFREF_DEFAULT_CODEC.deserialize(input);
96                 } else if (type instanceof InstanceIdentifierTypeDefinition) {
97                     if (input instanceof IdentityValuesDTO) {
98                         return instanceIdentifier.deserialize(input);
99                     }
100                     logger.info(
101                             "Value is not instance of InstanceIdentifierTypeDefinition but is {}. Therefore NULL is used as translation of  - {}",
102                             input == null ? "null" : input.getClass(), String.valueOf(input));
103                     return null;
104                 } else {
105                     TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
106                             .from(type);
107                     if (typeAwarecodec != null) {
108                         if (input instanceof IdentityValuesDTO) {
109                             return typeAwarecodec.deserialize(((IdentityValuesDTO) input).getOriginValue());
110                         }
111                         return typeAwarecodec.deserialize(String.valueOf(input));
112                     } else {
113                         logger.debug("Codec for type \"" + type.getQName().getLocalName()
114                                 + "\" is not implemented yet.");
115                         return null;
116                     }
117                 }
118             } catch (ClassCastException e) { // TODO remove this catch when everyone use codecs
119                 logger.error(
120                         "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
121                         e);
122                 return null;
123             }
124         }
125
126         @SuppressWarnings("unchecked")
127         @Override
128         public Object serialize(final Object input) {
129             try {
130                 if (type instanceof IdentityrefTypeDefinition) {
131                     return identityrefCodec.serialize(input);
132                 } else if (type instanceof LeafrefTypeDefinition) {
133                     return LEAFREF_DEFAULT_CODEC.serialize(input);
134                 } else if (type instanceof InstanceIdentifierTypeDefinition) {
135                     return instanceIdentifier.serialize(input);
136                 } else {
137                     TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
138                             .from(type);
139                     if (typeAwarecodec != null) {
140                         return typeAwarecodec.serialize(input);
141                     } else {
142                         logger.debug("Codec for type \"" + type.getQName().getLocalName()
143                                 + "\" is not implemented yet.");
144                         return null;
145                     }
146                 }
147             } catch (ClassCastException e) { // TODO remove this catch when everyone use codecs
148                 logger.error(
149                         "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
150                         e);
151                 return input;
152             }
153         }
154
155     }
156
157     public static class IdentityrefCodecImpl implements IdentityrefCodec<IdentityValuesDTO> {
158
159         private final Logger logger = LoggerFactory.getLogger(IdentityrefCodecImpl.class);
160
161         private final MountInstance mountPoint;
162
163         public IdentityrefCodecImpl(final MountInstance mountPoint) {
164             this.mountPoint = mountPoint;
165         }
166
167         @Override
168         public IdentityValuesDTO serialize(final QName data) {
169             return new IdentityValuesDTO(data.getNamespace().toString(), data.getLocalName(), data.getPrefix(), null);
170         }
171
172         @Override
173         public QName deserialize(final IdentityValuesDTO data) {
174             IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
175             Module module = getModuleByNamespace(valueWithNamespace.getNamespace(), mountPoint);
176             if (module == null) {
177                 logger.info("Module was not found for namespace {}", valueWithNamespace.getNamespace());
178                 logger.info("Idenetityref will be translated as NULL for data - {}", String.valueOf(valueWithNamespace));
179                 return null;
180             }
181
182             return QName.create(module.getNamespace(), module.getRevision(), valueWithNamespace.getValue());
183         }
184
185     }
186
187     public static class LeafrefCodecImpl implements LeafrefCodec<String> {
188
189         @Override
190         public String serialize(final Object data) {
191             return String.valueOf(data);
192         }
193
194         @Override
195         public Object deserialize(final String data) {
196             return data;
197         }
198
199     }
200
201     public static class InstanceIdentifierCodecImpl implements InstanceIdentifierCodec<IdentityValuesDTO> {
202         private final Logger logger = LoggerFactory.getLogger(InstanceIdentifierCodecImpl.class);
203         private final MountInstance mountPoint;
204
205         public InstanceIdentifierCodecImpl(final MountInstance mountPoint) {
206             this.mountPoint = mountPoint;
207         }
208
209         @Override
210         public IdentityValuesDTO serialize(final InstanceIdentifier data) {
211             IdentityValuesDTO identityValuesDTO = new IdentityValuesDTO();
212             for (PathArgument pathArgument : data.getPathArguments()) {
213                 IdentityValue identityValue = qNameToIdentityValue(pathArgument.getNodeType());
214                 if (pathArgument instanceof NodeIdentifierWithPredicates && identityValue != null) {
215                     List<Predicate> predicates = keyValuesToPredicateList(((NodeIdentifierWithPredicates) pathArgument)
216                             .getKeyValues());
217                     identityValue.setPredicates(predicates);
218                 } else if (pathArgument instanceof NodeWithValue && identityValue != null) {
219                     List<Predicate> predicates = new ArrayList<>();
220                     String value = String.valueOf(((NodeWithValue) pathArgument).getValue());
221                     predicates.add(new Predicate(null, value));
222                     identityValue.setPredicates(predicates);
223                 }
224                 identityValuesDTO.add(identityValue);
225             }
226             return identityValuesDTO;
227         }
228
229         @Override
230         public InstanceIdentifier deserialize(final IdentityValuesDTO data) {
231             List<PathArgument> result = new ArrayList<PathArgument>();
232             IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
233             Module module = getModuleByNamespace(valueWithNamespace.getNamespace(), mountPoint);
234             if (module == null) {
235                 logger.info("Module by namespace '{}' of first node in instance-identiefier was not found.",
236                         valueWithNamespace.getNamespace());
237                 logger.info("Instance-identifier will be translated as NULL for data - {}",
238                         String.valueOf(valueWithNamespace.getValue()));
239                 return null;
240             }
241
242             DataNodeContainer parentContainer = module;
243             List<IdentityValue> identities = data.getValuesWithNamespaces();
244             for (int i = 0; i < identities.size(); i++) {
245                 IdentityValue identityValue = identities.get(i);
246                 URI validNamespace = resolveValidNamespace(identityValue.getNamespace(), mountPoint);
247                 DataSchemaNode node = ControllerContext.getInstance().findInstanceDataChildByNameAndNamespace(
248                         parentContainer, identityValue.getValue(), validNamespace);
249                 if (node == null) {
250                     logger.info("'{}' node was not found in {}", identityValue, parentContainer.getChildNodes());
251                     logger.info("Instance-identifier will be translated as NULL for data - {}",
252                             String.valueOf(identityValue.getValue()));
253                     return null;
254                 }
255                 QName qName = node.getQName();
256                 PathArgument pathArgument = null;
257                 if (identityValue.getPredicates().isEmpty()) {
258                     pathArgument = new NodeIdentifier(qName);
259                 } else {
260                     if (node instanceof LeafListSchemaNode) { // predicate is value of leaf-list entry
261                         Predicate leafListPredicate = identityValue.getPredicates().get(0);
262                         if (!leafListPredicate.isLeafList()) {
263                             logger.info("Predicate's data is not type of leaf-list. It should be in format \".='value'\"");
264                             logger.info("Instance-identifier will be translated as NULL for data - {}",
265                                     String.valueOf(identityValue.getValue()));
266                             return null;
267                         }
268                         pathArgument = new NodeWithValue(qName, leafListPredicate.getValue());
269                     } else if (node instanceof ListSchemaNode) { // predicates are keys of list
270                         DataNodeContainer listNode = (DataNodeContainer) node;
271                         Map<QName, Object> predicatesMap = new HashMap<>();
272                         for (Predicate predicate : identityValue.getPredicates()) {
273                             validNamespace = resolveValidNamespace(predicate.getName().getNamespace(), mountPoint);
274                             DataSchemaNode listKey = ControllerContext.getInstance()
275                                     .findInstanceDataChildByNameAndNamespace(listNode, predicate.getName().getValue(),
276                                             validNamespace);
277                             predicatesMap.put(listKey.getQName(), predicate.getValue());
278                         }
279                         pathArgument = new NodeIdentifierWithPredicates(qName, predicatesMap);
280                     } else {
281                         logger.info("Node {} is not List or Leaf-list.", node);
282                         logger.info("Instance-identifier will be translated as NULL for data - {}",
283                                 String.valueOf(identityValue.getValue()));
284                         return null;
285                     }
286                 }
287                 result.add(pathArgument);
288                 if (i < identities.size() - 1) { // last element in instance-identifier can be other than
289                                                  // DataNodeContainer
290                     if (node instanceof DataNodeContainer) {
291                         parentContainer = (DataNodeContainer) node;
292                     } else {
293                         logger.info("Node {} isn't instance of DataNodeContainer", node);
294                         logger.info("Instance-identifier will be translated as NULL for data - {}",
295                                 String.valueOf(identityValue.getValue()));
296                         return null;
297                     }
298                 }
299             }
300
301             return result.isEmpty() ? null : InstanceIdentifier.create(result);
302         }
303
304         private List<Predicate> keyValuesToPredicateList(final Map<QName, Object> keyValues) {
305             List<Predicate> result = new ArrayList<>();
306             for (QName qName : keyValues.keySet()) {
307                 Object value = keyValues.get(qName);
308                 result.add(new Predicate(qNameToIdentityValue(qName), String.valueOf(value)));
309             }
310             return result;
311         }
312
313         private IdentityValue qNameToIdentityValue(final QName qName) {
314             if (qName != null) {
315                 return new IdentityValue(qName.getNamespace().toString(), qName.getLocalName(), qName.getPrefix());
316             }
317             return null;
318         }
319     }
320
321     private static Module getModuleByNamespace(final String namespace, final MountInstance mountPoint) {
322         URI validNamespace = resolveValidNamespace(namespace, mountPoint);
323
324         Module module = null;
325         if (mountPoint != null) {
326             module = ControllerContext.getInstance().findModuleByNamespace(mountPoint, validNamespace);
327         } else {
328             module = ControllerContext.getInstance().findModuleByNamespace(validNamespace);
329         }
330         if (module == null) {
331             logger.info("Module for namespace " + validNamespace + " wasn't found.");
332             return null;
333         }
334         return module;
335     }
336
337     private static URI resolveValidNamespace(final String namespace, final MountInstance mountPoint) {
338         URI validNamespace;
339         if (mountPoint != null) {
340             validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(mountPoint, namespace);
341         } else {
342             validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(namespace);
343         }
344         if (validNamespace == null) {
345             validNamespace = URI.create(namespace);
346         }
347
348         return validNamespace;
349     }
350
351 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.