+++ /dev/null
-/*
- * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,
- * and is available at http://www.eclipse.org/legal/epl-v10.html
- */
-package org.opendaylight.controller.sal.restconf.impl;
-
-import java.net.URI;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
-import org.opendaylight.controller.sal.rest.impl.RestUtil;
-import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue;
-import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate;
-import org.opendaylight.yangtools.concepts.Codec;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
-import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.codec.IdentityrefCodec;
-import org.opendaylight.yangtools.yang.data.api.codec.InstanceIdentifierCodec;
-import org.opendaylight.yangtools.yang.data.api.codec.LeafrefCodec;
-import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-public class RestCodec {
-
- private static final Logger logger = LoggerFactory.getLogger(RestCodec.class);
-
- private RestCodec() {
- }
-
- public static final Codec<Object, Object> from(final TypeDefinition<?> typeDefinition,
- final DOMMountPoint mountPoint) {
- return new ObjectCodec(typeDefinition, mountPoint);
- }
-
- @SuppressWarnings("rawtypes")
- public static final class ObjectCodec implements Codec<Object, Object> {
-
- private final Logger logger = LoggerFactory.getLogger(RestCodec.class);
-
- public static final Codec LEAFREF_DEFAULT_CODEC = new LeafrefCodecImpl();
- private final Codec instanceIdentifier;
- private final Codec identityrefCodec;
-
- private final TypeDefinition<?> type;
-
- private ObjectCodec(final TypeDefinition<?> typeDefinition, final DOMMountPoint mountPoint) {
- type = RestUtil.resolveBaseTypeFrom(typeDefinition);
- if (type instanceof IdentityrefTypeDefinition) {
- identityrefCodec = new IdentityrefCodecImpl(mountPoint);
- } else {
- identityrefCodec = null;
- }
- if (type instanceof InstanceIdentifierTypeDefinition) {
- instanceIdentifier = new InstanceIdentifierCodecImpl(mountPoint);
- } else {
- instanceIdentifier = null;
- }
- }
-
- @SuppressWarnings("unchecked")
- @Override
- public Object deserialize(final Object input) {
- try {
- if (type instanceof IdentityrefTypeDefinition) {
- if (input instanceof IdentityValuesDTO) {
- return identityrefCodec.deserialize(input);
- }
- logger.debug(
- "Value is not instance of IdentityrefTypeDefinition but is {}. Therefore NULL is used as translation of - {}",
- input == null ? "null" : input.getClass(), String.valueOf(input));
- return null;
- } else if (type instanceof InstanceIdentifierTypeDefinition) {
- if (input instanceof IdentityValuesDTO) {
- return instanceIdentifier.deserialize(input);
- }
- logger.info(
- "Value is not instance of InstanceIdentifierTypeDefinition but is {}. Therefore NULL is used as translation of - {}",
- input == null ? "null" : input.getClass(), String.valueOf(input));
- return null;
- } else {
- final TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
- .from(type);
- if (typeAwarecodec != null) {
- if (input instanceof IdentityValuesDTO) {
- return typeAwarecodec.deserialize(((IdentityValuesDTO) input).getOriginValue());
- }
- return typeAwarecodec.deserialize(String.valueOf(input));
- } else {
- logger.debug("Codec for type \"" + type.getQName().getLocalName()
- + "\" is not implemented yet.");
- return null;
- }
- }
- } catch (final ClassCastException e) { // TODO remove this catch when everyone use codecs
- logger.error(
- "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
- e);
- return null;
- }
- }
-
- @SuppressWarnings("unchecked")
- @Override
- public Object serialize(final Object input) {
- try {
- if (type instanceof IdentityrefTypeDefinition) {
- return identityrefCodec.serialize(input);
- } else if (type instanceof LeafrefTypeDefinition) {
- return LEAFREF_DEFAULT_CODEC.serialize(input);
- } else if (type instanceof InstanceIdentifierTypeDefinition) {
- return instanceIdentifier.serialize(input);
- } else {
- final TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> typeAwarecodec = TypeDefinitionAwareCodec
- .from(type);
- if (typeAwarecodec != null) {
- return typeAwarecodec.serialize(input);
- } else {
- logger.debug("Codec for type \"" + type.getQName().getLocalName()
- + "\" is not implemented yet.");
- return null;
- }
- }
- } catch (final ClassCastException e) { // TODO remove this catch when everyone use codecs
- logger.error(
- "ClassCastException was thrown when codec is invoked with parameter " + String.valueOf(input),
- e);
- return input;
- }
- }
-
- }
-
- public static class IdentityrefCodecImpl implements IdentityrefCodec<IdentityValuesDTO> {
-
- private final Logger logger = LoggerFactory.getLogger(IdentityrefCodecImpl.class);
-
- private final DOMMountPoint mountPoint;
-
- public IdentityrefCodecImpl(final DOMMountPoint mountPoint) {
- this.mountPoint = mountPoint;
- }
-
- @Override
- public IdentityValuesDTO serialize(final QName data) {
- return new IdentityValuesDTO(data.getNamespace().toString(), data.getLocalName(), null, null);
- }
-
- @Override
- public QName deserialize(final IdentityValuesDTO data) {
- final IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
- final Module module = getModuleByNamespace(valueWithNamespace.getNamespace(), mountPoint);
- if (module == null) {
- logger.info("Module was not found for namespace {}", valueWithNamespace.getNamespace());
- logger.info("Idenetityref will be translated as NULL for data - {}", String.valueOf(valueWithNamespace));
- return null;
- }
-
- return QName.create(module.getNamespace(), module.getRevision(), valueWithNamespace.getValue());
- }
-
- }
-
- public static class LeafrefCodecImpl implements LeafrefCodec<String> {
-
- @Override
- public String serialize(final Object data) {
- return String.valueOf(data);
- }
-
- @Override
- public Object deserialize(final String data) {
- return data;
- }
-
- }
-
- public static class InstanceIdentifierCodecImpl implements InstanceIdentifierCodec<IdentityValuesDTO> {
- private final Logger logger = LoggerFactory.getLogger(InstanceIdentifierCodecImpl.class);
- private final DOMMountPoint mountPoint;
-
- public InstanceIdentifierCodecImpl(final DOMMountPoint mountPoint) {
- this.mountPoint = mountPoint;
- }
-
- @Override
- public IdentityValuesDTO serialize(final YangInstanceIdentifier data) {
- final IdentityValuesDTO identityValuesDTO = new IdentityValuesDTO();
- for (final PathArgument pathArgument : data.getPathArguments()) {
- final IdentityValue identityValue = qNameToIdentityValue(pathArgument.getNodeType());
- if (pathArgument instanceof NodeIdentifierWithPredicates && identityValue != null) {
- final List<Predicate> predicates = keyValuesToPredicateList(((NodeIdentifierWithPredicates) pathArgument)
- .getKeyValues());
- identityValue.setPredicates(predicates);
- } else if (pathArgument instanceof NodeWithValue && identityValue != null) {
- final List<Predicate> predicates = new ArrayList<>();
- final String value = String.valueOf(((NodeWithValue) pathArgument).getValue());
- predicates.add(new Predicate(null, value));
- identityValue.setPredicates(predicates);
- }
- identityValuesDTO.add(identityValue);
- }
- return identityValuesDTO;
- }
-
- @Override
- public YangInstanceIdentifier deserialize(final IdentityValuesDTO data) {
- final List<PathArgument> result = new ArrayList<PathArgument>();
- final IdentityValue valueWithNamespace = data.getValuesWithNamespaces().get(0);
- final Module module = getModuleByNamespace(valueWithNamespace.getNamespace(), mountPoint);
- if (module == null) {
- logger.info("Module by namespace '{}' of first node in instance-identifier was not found.",
- valueWithNamespace.getNamespace());
- logger.info("Instance-identifier will be translated as NULL for data - {}",
- String.valueOf(valueWithNamespace.getValue()));
- return null;
- }
-
- DataNodeContainer parentContainer = module;
- final List<IdentityValue> identities = data.getValuesWithNamespaces();
- for (int i = 0; i < identities.size(); i++) {
- final IdentityValue identityValue = identities.get(i);
- URI validNamespace = resolveValidNamespace(identityValue.getNamespace(), mountPoint);
- final DataSchemaNode node = ControllerContext.findInstanceDataChildByNameAndNamespace(
- parentContainer, identityValue.getValue(), validNamespace);
- if (node == null) {
- logger.info("'{}' node was not found in {}", identityValue, parentContainer.getChildNodes());
- logger.info("Instance-identifier will be translated as NULL for data - {}",
- String.valueOf(identityValue.getValue()));
- return null;
- }
- final QName qName = node.getQName();
- PathArgument pathArgument = null;
- if (identityValue.getPredicates().isEmpty()) {
- pathArgument = new NodeIdentifier(qName);
- } else {
- if (node instanceof LeafListSchemaNode) { // predicate is value of leaf-list entry
- final Predicate leafListPredicate = identityValue.getPredicates().get(0);
- if (!leafListPredicate.isLeafList()) {
- logger.info("Predicate's data is not type of leaf-list. It should be in format \".='value'\"");
- logger.info("Instance-identifier will be translated as NULL for data - {}",
- String.valueOf(identityValue.getValue()));
- return null;
- }
- pathArgument = new NodeWithValue(qName, leafListPredicate.getValue());
- } else if (node instanceof ListSchemaNode) { // predicates are keys of list
- final DataNodeContainer listNode = (DataNodeContainer) node;
- final Map<QName, Object> predicatesMap = new HashMap<>();
- for (final Predicate predicate : identityValue.getPredicates()) {
- validNamespace = resolveValidNamespace(predicate.getName().getNamespace(), mountPoint);
- final DataSchemaNode listKey = ControllerContext
- .findInstanceDataChildByNameAndNamespace(listNode, predicate.getName().getValue(),
- validNamespace);
- predicatesMap.put(listKey.getQName(), predicate.getValue());
- }
- pathArgument = new NodeIdentifierWithPredicates(qName, predicatesMap);
- } else {
- logger.info("Node {} is not List or Leaf-list.", node);
- logger.info("Instance-identifier will be translated as NULL for data - {}",
- String.valueOf(identityValue.getValue()));
- return null;
- }
- }
- result.add(pathArgument);
- if (i < identities.size() - 1) { // last element in instance-identifier can be other than
- // DataNodeContainer
- if (node instanceof DataNodeContainer) {
- parentContainer = (DataNodeContainer) node;
- } else {
- logger.info("Node {} isn't instance of DataNodeContainer", node);
- logger.info("Instance-identifier will be translated as NULL for data - {}",
- String.valueOf(identityValue.getValue()));
- return null;
- }
- }
- }
-
- return result.isEmpty() ? null : YangInstanceIdentifier.create(result);
- }
-
- private List<Predicate> keyValuesToPredicateList(final Map<QName, Object> keyValues) {
- final List<Predicate> result = new ArrayList<>();
- for (final QName qName : keyValues.keySet()) {
- final Object value = keyValues.get(qName);
- result.add(new Predicate(qNameToIdentityValue(qName), String.valueOf(value)));
- }
- return result;
- }
-
- private IdentityValue qNameToIdentityValue(final QName qName) {
- if (qName != null) {
- return new IdentityValue(qName.getNamespace().toString(), qName.getLocalName());
- }
- return null;
- }
- }
-
- private static Module getModuleByNamespace(final String namespace, final DOMMountPoint mountPoint) {
- final URI validNamespace = resolveValidNamespace(namespace, mountPoint);
-
- Module module = null;
- if (mountPoint != null) {
- module = ControllerContext.getInstance().findModuleByNamespace(mountPoint, validNamespace);
- } else {
- module = ControllerContext.getInstance().findModuleByNamespace(validNamespace);
- }
- if (module == null) {
- logger.info("Module for namespace " + validNamespace + " wasn't found.");
- return null;
- }
- return module;
- }
-
- private static URI resolveValidNamespace(final String namespace, final DOMMountPoint mountPoint) {
- URI validNamespace;
- if (mountPoint != null) {
- validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(mountPoint, namespace);
- } else {
- validNamespace = ControllerContext.getInstance().findNamespaceByModuleName(namespace);
- }
- if (validNamespace == null) {
- validNamespace = URI.create(namespace);
- }
-
- return validNamespace;
- }
-
-}