2 * Copyright (c) 2014 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
8 package org.opendaylight.controller.sal.restconf.impl;
11 import java.util.ArrayList;
12 import java.util.HashMap;
13 import java.util.List;
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;
42 public class RestCodec {
44 private static final Logger logger = LoggerFactory.getLogger(RestCodec.class);
49 public static final Codec<Object, Object> from(final TypeDefinition<?> typeDefinition,
50 final MountInstance mountPoint) {
51 return new ObjectCodec(typeDefinition, mountPoint);
54 @SuppressWarnings("rawtypes")
55 public static final class ObjectCodec implements Codec<Object, Object> {
57 private final Logger logger = LoggerFactory.getLogger(RestCodec.class);
59 public static final Codec LEAFREF_DEFAULT_CODEC = new LeafrefCodecImpl();
60 private final Codec instanceIdentifier;
61 private final Codec identityrefCodec;
63 private final TypeDefinition<?> type;
65 private ObjectCodec(final TypeDefinition<?> typeDefinition, final MountInstance mountPoint) {
66 type = RestUtil.resolveBaseTypeFrom(typeDefinition);
67 if (type instanceof IdentityrefTypeDefinition) {
68 identityrefCodec = new IdentityrefCodecImpl(mountPoint);
70 identityrefCodec = null;
72 if (type instanceof InstanceIdentifierTypeDefinition) {
73 instanceIdentifier = new InstanceIdentifierCodecImpl(mountPoint);
75 instanceIdentifier = null;
79 @SuppressWarnings("unchecked")
81 public Object deserialize(final Object input) {
83 if (type instanceof IdentityrefTypeDefinition) {
84 if (input instanceof IdentityValuesDTO) {
85 return identityrefCodec.deserialize(input);
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));
91 } else if (type instanceof LeafrefTypeDefinition) {
92 if (input instanceof IdentityValuesDTO) {
93 return LEAFREF_DEFAULT_CODEC.deserialize(((IdentityValuesDTO) input).getOriginValue());
95 return LEAFREF_DEFAULT_CODEC.deserialize(input);
96 } else if (type instanceof InstanceIdentifierTypeDefinition) {
97 if (input instanceof IdentityValuesDTO) {
98 return instanceIdentifier.deserialize(input);
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));
105 TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
107 if (typeAwarecodec != null) {
108 if (input instanceof IdentityValuesDTO) {
109 return typeAwarecodec.deserialize(((IdentityValuesDTO) input).getOriginValue());
111 return typeAwarecodec.deserialize(String.valueOf(input));
113 logger.debug("Codec for type \"" + type.getQName().getLocalName()
114 + "\" is not implemented yet.");
118 } catch (ClassCastException e) { // TODO remove this catch when everyone use codecs
120 "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
126 @SuppressWarnings("unchecked")
128 public Object serialize(final Object input) {
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);
137 TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
139 if (typeAwarecodec != null) {
140 return typeAwarecodec.serialize(input);
142 logger.debug("Codec for type \"" + type.getQName().getLocalName()
143 + "\" is not implemented yet.");
147 } catch (ClassCastException e) { // TODO remove this catch when everyone use codecs
149 "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
157 public static class IdentityrefCodecImpl implements IdentityrefCodec<IdentityValuesDTO> {
159 private final Logger logger = LoggerFactory.getLogger(IdentityrefCodecImpl.class);
161 private final MountInstance mountPoint;
163 public IdentityrefCodecImpl(final MountInstance mountPoint) {
164 this.mountPoint = mountPoint;
168 public IdentityValuesDTO serialize(final QName data) {
169 return new IdentityValuesDTO(data.getNamespace().toString(), data.getLocalName(), data.getPrefix(), null);
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));
182 return QName.create(module.getNamespace(), module.getRevision(), valueWithNamespace.getValue());
187 public static class LeafrefCodecImpl implements LeafrefCodec<String> {
190 public String serialize(final Object data) {
191 return String.valueOf(data);
195 public Object deserialize(final String data) {
201 public static class InstanceIdentifierCodecImpl implements InstanceIdentifierCodec<IdentityValuesDTO> {
202 private final Logger logger = LoggerFactory.getLogger(InstanceIdentifierCodecImpl.class);
203 private final MountInstance mountPoint;
205 public InstanceIdentifierCodecImpl(final MountInstance mountPoint) {
206 this.mountPoint = mountPoint;
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)
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);
224 identityValuesDTO.add(identityValue);
226 return identityValuesDTO;
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()));
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);
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()));
255 QName qName = node.getQName();
256 PathArgument pathArgument = null;
257 if (identityValue.getPredicates().isEmpty()) {
258 pathArgument = new NodeIdentifier(qName);
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()));
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(),
277 predicatesMap.put(listKey.getQName(), predicate.getValue());
279 pathArgument = new NodeIdentifierWithPredicates(qName, predicatesMap);
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()));
287 result.add(pathArgument);
288 if (i < identities.size() - 1) { // last element in instance-identifier can be other than
290 if (node instanceof DataNodeContainer) {
291 parentContainer = (DataNodeContainer) node;
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()));
301 return result.isEmpty() ? null : InstanceIdentifier.create(result);
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)));
313 private IdentityValue qNameToIdentityValue(final QName qName) {
315 return new IdentityValue(qName.getNamespace().toString(), qName.getLocalName(), qName.getPrefix());
321 private static Module getModuleByNamespace(final String namespace, final MountInstance mountPoint) {
322 URI validNamespace = resolveValidNamespace(namespace, mountPoint);
324 Module module = null;
325 if (mountPoint != null) {
326 module = ControllerContext.getInstance().findModuleByNamespace(mountPoint, validNamespace);
328 module = ControllerContext.getInstance().findModuleByNamespace(validNamespace);
330 if (module == null) {
331 logger.info("Module for namespace " + validNamespace + " wasn't found.");
337 private static URI resolveValidNamespace(final String namespace, final MountInstance mountPoint) {
339 if (mountPoint != null) {
340 validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(mountPoint, namespace);
342 validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(namespace);
344 if (validNamespace == null) {
345 validNamespace = URI.create(namespace);
348 return validNamespace;