BUG 392: Resolved translation to JSON behind mount point
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / rest / impl / JsonMapper.java
index 36b46a171cde4706a1b7e22d17ed4c7e00ccdc90..ca318e4f3692d28da298810d0b4ff7272bc4f615 100644 (file)
@@ -1,16 +1,51 @@
+/*
+ * 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.rest.impl;
 
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import java.io.IOException;
-import java.util.*;
+import java.net.URI;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
 
 import javax.activation.UnsupportedDataTypeException;
 
+import org.opendaylight.controller.sal.core.api.mount.MountInstance;
 import org.opendaylight.controller.sal.restconf.impl.ControllerContext;
-import org.opendaylight.yangtools.yang.data.api.*;
-import org.opendaylight.yangtools.yang.model.api.*;
-import org.opendaylight.yangtools.yang.model.api.type.*;
+import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO;
+import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.IdentityValue;
+import org.opendaylight.controller.sal.restconf.impl.IdentityValuesDTO.Predicate;
+import org.opendaylight.controller.sal.restconf.impl.RestCodec;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.CompositeNode;
+import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.Node;
+import org.opendaylight.yangtools.yang.data.api.SimpleNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+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.LeafSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.BooleanTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.DecimalTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.EmptyTypeDefinition;
+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.IntegerTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.UnsignedIntegerTypeDefinition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import com.google.common.base.Preconditions;
 import com.google.gson.stream.JsonWriter;
@@ -19,11 +54,15 @@ class JsonMapper {
 
     private final Set<LeafListSchemaNode> foundLeafLists = new HashSet<>();
     private final Set<ListSchemaNode> foundLists = new HashSet<>();
+    private MountInstance mountPoint;
+    private final Logger logger = LoggerFactory.getLogger(JsonMapper.class);
 
-    public void write(JsonWriter writer, CompositeNode data, DataNodeContainer schema) throws IOException {
+    public void write(JsonWriter writer, CompositeNode data, DataNodeContainer schema, MountInstance mountPoint)
+            throws IOException {
         Preconditions.checkNotNull(writer);
         Preconditions.checkNotNull(data);
         Preconditions.checkNotNull(schema);
+        this.mountPoint = mountPoint;
 
         writer.beginObject();
 
@@ -47,26 +86,13 @@ class JsonMapper {
         checkNotNull(parent);
         checkNotNull(parentSchema);
 
-        List<String> longestPathToElementViaChoiceCase = new ArrayList<>();
         for (Node<?> child : parent.getChildren()) {
-            Deque<String> choiceCasePathStack = new ArrayDeque<>(longestPathToElementViaChoiceCase);
-            SchemaLocation schemaLocation = findFirstSchemaForNode(child, parentSchema.getChildNodes(),
-                    choiceCasePathStack);
-
-            if (schemaLocation == null) {
-                if (!choiceCasePathStack.isEmpty()) {
-                    throw new UnsupportedDataTypeException("On choice-case path " + choiceCasePathStack
-                            + " wasn't found data schema for " + child.getNodeType().getLocalName());
-                } else {
-                    throw new UnsupportedDataTypeException("Probably the data node \""
-                            + child.getNodeType().getLocalName() + "\" is not conform to schema");
-                }
-            }
+            DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchema.getChildNodes());
 
-            longestPathToElementViaChoiceCase = resolveLongerPath(longestPathToElementViaChoiceCase,
-                    schemaLocation.getLocation());
-
-            DataSchemaNode childSchema = schemaLocation.getSchema();
+            if (childSchema == null) {
+                throw new UnsupportedDataTypeException("Probably the data node \"" + child.getNodeType().getLocalName()
+                        + "\" is not conform to schema");
+            }
 
             if (childSchema instanceof ContainerSchemaNode) {
                 Preconditions.checkState(child instanceof CompositeNode,
@@ -97,10 +123,7 @@ class JsonMapper {
         }
 
         for (Node<?> child : parent.getChildren()) {
-            SchemaLocation schemaLocation = findFirstSchemaForNode(child, parentSchema.getChildNodes(),
-                    new ArrayDeque<>(longestPathToElementViaChoiceCase));
-
-            DataSchemaNode childSchema = schemaLocation.getSchema();
+            DataSchemaNode childSchema = findFirstSchemaForNode(child, parentSchema.getChildNodes());
             if (childSchema instanceof LeafListSchemaNode) {
                 foundLeafLists.remove((LeafListSchemaNode) childSchema);
             } else if (childSchema instanceof ListSchemaNode) {
@@ -109,45 +132,17 @@ class JsonMapper {
         }
     }
 
-    private List<String> resolveLongerPath(List<String> l1, List<String> l2) {
-        return l1.size() > l2.size() ? l1 : l2;
-    }
-
-    private SchemaLocation findFirstSchemaForNode(Node<?> node, Set<DataSchemaNode> dataSchemaNode,
-            Deque<String> pathIterator) {
-        Map<String, ChoiceNode> choiceSubnodes = new HashMap<>();
+    private DataSchemaNode findFirstSchemaForNode(Node<?> node, Set<DataSchemaNode> dataSchemaNode) {
         for (DataSchemaNode dsn : dataSchemaNode) {
-            if (dsn instanceof ChoiceNode) {
-                choiceSubnodes.put(dsn.getQName().getLocalName(), (ChoiceNode) dsn);
-            } else if (node.getNodeType().getLocalName().equals(dsn.getQName().getLocalName())) {
-                return new SchemaLocation(dsn);
-            }
-        }
-
-        for (ChoiceNode choiceSubnode : choiceSubnodes.values()) {
-            if ((!pathIterator.isEmpty() && pathIterator.peekLast().equals(choiceSubnode.getQName().getLocalName()))
-                    || pathIterator.isEmpty()) {
-                String pathPartChoice = pathIterator.pollLast();
-                for (ChoiceCaseNode concreteCase : choiceSubnode.getCases()) {
-                    if ((!pathIterator.isEmpty() && pathIterator.peekLast().equals(
-                            concreteCase.getQName().getLocalName()))
-                            || pathIterator.isEmpty()) {
-                        String pathPartCase = pathIterator.pollLast();
-                        SchemaLocation schemaLocation = findFirstSchemaForNode(node, concreteCase.getChildNodes(),
-                                pathIterator);
-                        if (schemaLocation != null) {
-                            schemaLocation.addPathPart(concreteCase.getQName().getLocalName());
-                            schemaLocation.addPathPart(choiceSubnode.getQName().getLocalName());
-                            return schemaLocation;
-                        }
-                        if (pathPartCase != null) {
-                            pathIterator.addLast(pathPartCase);
-                        }
+            if (node.getNodeType().equals(dsn.getQName())) {
+                return dsn;
+            } else if (dsn instanceof ChoiceNode) {
+                for (ChoiceCaseNode choiceCase : ((ChoiceNode) dsn).getCases()) {
+                    DataSchemaNode foundDsn = findFirstSchemaForNode(node, choiceCase.getChildNodes());
+                    if (foundDsn != null) {
+                        return foundDsn;
                     }
                 }
-                if (pathPartChoice != null) {
-                    pathIterator.addLast(pathPartChoice);
-                }
             }
         }
         return null;
@@ -188,120 +183,133 @@ class JsonMapper {
 
         List<SimpleNode<?>> nodeLeafLists = nodeParent.getSimpleNodesByName(node.getNodeType());
         for (SimpleNode<?> nodeLeafList : nodeLeafLists) {
-            writeValueOfNodeByType(writer, nodeLeafList, schema.getType());
+            writeValueOfNodeByType(writer, nodeLeafList, schema.getType(), schema);
         }
-
         writer.endArray();
     }
 
     private void writeLeaf(JsonWriter writer, SimpleNode<?> node, LeafSchemaNode schema) throws IOException {
         writeName(node, schema, writer);
-        writeValueOfNodeByType(writer, node, schema.getType());
+        writeValueOfNodeByType(writer, node, schema.getType(), schema);
     }
 
-    private void writeValueOfNodeByType(JsonWriter writer, SimpleNode<?> node, TypeDefinition<?> type)
-            throws IOException {
+    private void writeValueOfNodeByType(JsonWriter writer, SimpleNode<?> node, TypeDefinition<?> type,
+            DataSchemaNode schema) throws IOException {
 
-        String value = String.valueOf(node.getValue());
-        // TODO check Leafref, InstanceIdentifierTypeDefinition,
-        // IdentityrefTypeDefinition, UnionTypeDefinition
-        TypeDefinition<?> baseType = resolveBaseTypeFrom(type);
-        if (baseType instanceof InstanceIdentifierTypeDefinition) {
-            writer.value(((InstanceIdentifierTypeDefinition) baseType).getPathStatement().toString());
-        } else if (baseType instanceof UnionTypeDefinition) {
-            processTypeIsUnionType(writer, (UnionTypeDefinition) baseType, value);
+        TypeDefinition<?> baseType = RestUtil.resolveBaseTypeFrom(type);
+
+        if (node.getValue() == null && !(baseType instanceof EmptyTypeDefinition)) {
+            logger.debug("While generationg JSON output null value was found for type "
+                    + baseType.getClass().getSimpleName() + ".");
+        }
+
+        // TODO check InstanceIdentifierTypeDefinition
+        if (baseType instanceof IdentityrefTypeDefinition) {
+            if (node.getValue() instanceof QName) {
+                IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize(
+                        node.getValue());
+                IdentityValue valueFromDTO = valueDTO.getValuesWithNamespaces().get(0);
+                String moduleName;
+                if (mountPoint != null) {
+                    moduleName = ControllerContext.getInstance().findModuleNameByNamespace(mountPoint,
+                            URI.create(valueFromDTO.getNamespace()));
+                } else {
+                    moduleName = ControllerContext.getInstance().findModuleNameByNamespace(
+                            URI.create(valueFromDTO.getNamespace()));
+                }
+                writer.value(moduleName + ":" + valueFromDTO.getValue());
+            } else {
+                writeStringRepresentation(writer, node, baseType, QName.class);
+            }
+        } else if (baseType instanceof InstanceIdentifierTypeDefinition) {
+            if (node.getValue() instanceof InstanceIdentifier) {
+                IdentityValuesDTO valueDTO = (IdentityValuesDTO) RestCodec.from(baseType, mountPoint).serialize(
+                        node.getValue());
+                writeIdentityValuesDTOToJson(writer, valueDTO);
+            } else {
+                writeStringRepresentation(writer, node, baseType, InstanceIdentifier.class);
+            }
         } else if (baseType instanceof DecimalTypeDefinition || baseType instanceof IntegerTypeDefinition
                 || baseType instanceof UnsignedIntegerTypeDefinition) {
-            writer.value(new NumberForJsonWriter(value));
+            writer.value(new NumberForJsonWriter((String) RestCodec.from(baseType, mountPoint).serialize(
+                    node.getValue())));
         } else if (baseType instanceof BooleanTypeDefinition) {
-            writer.value(Boolean.parseBoolean(value));
+            writer.value(Boolean.parseBoolean((String) RestCodec.from(baseType, mountPoint).serialize(node.getValue())));
         } else if (baseType instanceof EmptyTypeDefinition) {
             writeEmptyDataTypeToJson(writer);
         } else {
+            String value = String.valueOf(RestCodec.from(baseType, mountPoint).serialize(node.getValue()));
+            if (value == null) {
+                value = String.valueOf(node.getValue());
+            }
             writer.value(value.equals("null") ? "" : value);
         }
     }
 
-    private void processTypeIsUnionType(JsonWriter writer, UnionTypeDefinition unionType, String value)
-            throws IOException {
-        if (value == null) {
-            writeEmptyDataTypeToJson(writer);
-        } else if ((isNumber(value))
-                && containsType(unionType, UnsignedIntegerTypeDefinition.class, IntegerTypeDefinition.class,
-                        DecimalTypeDefinition.class)) {
-            writer.value(new NumberForJsonWriter(value));
-        } else if (isBoolean(value) && containsType(unionType, BooleanTypeDefinition.class)) {
-            writer.value(Boolean.parseBoolean(value));
-        } else {
-            writer.value(value);
-        }
-    }
-
-    private boolean isBoolean(String value) {
-        if (value.equals("true") || value.equals("false")) {
-            return true;
+    private void writeIdentityValuesDTOToJson(JsonWriter writer, IdentityValuesDTO valueDTO) throws IOException {
+        StringBuilder result = new StringBuilder();
+        for (IdentityValue identityValue : valueDTO.getValuesWithNamespaces()) {
+            result.append("/");
+
+            writeModuleNameAndIdentifier(result, identityValue);
+            if (identityValue.getPredicates() != null) {
+                for (Predicate predicate : identityValue.getPredicates()) {
+                    IdentityValue identityValuePredicate = predicate.getName();
+                    result.append("[");
+                    writeModuleNameAndIdentifier(result, identityValuePredicate);
+                    result.append("=\"");
+                    result.append(predicate.getValue());
+                    result.append("\"");
+                    result.append("]");
+                }
+            }
         }
-        return false;
-    }
 
-    private void writeEmptyDataTypeToJson(JsonWriter writer) throws IOException {
-        writer.beginArray();
-        writer.nullValue();
-        writer.endArray();
-    }
-
-    private boolean isNumber(String value) {
-        try {
-            Double.valueOf(value);
-        } catch (NumberFormatException e) {
-            return false;
-        }
-        return true;
+        writer.value(result.toString());
     }
 
-    private boolean containsType(UnionTypeDefinition unionType, Class<?>... searchedTypes) {
-        List<TypeDefinition<?>> allUnionSubtypes = resolveAllUnionSubtypesFrom(unionType);
-
-        for (TypeDefinition<?> unionSubtype : allUnionSubtypes) {
-            for (Class<?> searchedType : searchedTypes) {
-                if (searchedType.isInstance(unionSubtype)) {
-                    return true;
-                }
-            }
+    private void writeModuleNameAndIdentifier(StringBuilder result, IdentityValue identityValue) {
+        String moduleName = ControllerContext.getInstance().findModuleNameByNamespace(
+                URI.create(identityValue.getNamespace()));
+        if (moduleName != null && !moduleName.isEmpty()) {
+            result.append(moduleName);
+            result.append(":");
         }
-        return false;
+        result.append(identityValue.getValue());
     }
 
-    private List<TypeDefinition<?>> resolveAllUnionSubtypesFrom(UnionTypeDefinition inputType) {
-        List<TypeDefinition<?>> result = new ArrayList<>();
-        for (TypeDefinition<?> subtype : inputType.getTypes()) {
-            TypeDefinition<?> resolvedSubtype = subtype;
-
-            resolvedSubtype = resolveBaseTypeFrom(subtype);
-
-            if (resolvedSubtype instanceof UnionTypeDefinition) {
-                List<TypeDefinition<?>> subtypesFromRecursion = resolveAllUnionSubtypesFrom((UnionTypeDefinition) resolvedSubtype);
-                result.addAll(subtypesFromRecursion);
-            } else {
-                result.add(resolvedSubtype);
-            }
+    private void writeStringRepresentation(JsonWriter writer, SimpleNode<?> node, TypeDefinition<?> baseType,
+            Class<?> requiredType) throws IOException {
+        Object value = node.getValue();
+        logger.debug("Value of " + baseType.getQName().getNamespace() + ":" + baseType.getQName().getLocalName()
+                + " is not instance of " + requiredType.getClass() + " but is " + node.getValue().getClass());
+        if (value == null) {
+            writer.value("");
+        } else {
+            writer.value(String.valueOf(value));
         }
-
-        return result;
     }
 
-    private TypeDefinition<?> resolveBaseTypeFrom(TypeDefinition<?> type) {
-        return type.getBaseType() != null ? resolveBaseTypeFrom(type.getBaseType()) : type;
+    private void writeEmptyDataTypeToJson(JsonWriter writer) throws IOException {
+        writer.beginArray();
+        writer.nullValue();
+        writer.endArray();
     }
 
     private void writeName(Node<?> node, DataSchemaNode schema, JsonWriter writer) throws IOException {
         String nameForOutput = node.getNodeType().getLocalName();
         if (schema.isAugmenting()) {
             ControllerContext contContext = ControllerContext.getInstance();
-            CharSequence moduleName;
-            moduleName = contContext.toRestconfIdentifier(schema.getQName());
+            CharSequence moduleName = null;
+            if (mountPoint == null) {
+                moduleName = contContext.toRestconfIdentifier(schema.getQName());
+            } else {
+                moduleName = contContext.toRestconfIdentifier(mountPoint, schema.getQName());
+            }
             if (moduleName != null) {
                 nameForOutput = moduleName.toString();
+            } else {
+                logger.info("Module '{}' was not found in schema from mount point", schema.getQName());
             }
         }
         writer.name(nameForOutput);