Merge "Fix modules Restconf call for mounted devices"
[controller.git] / opendaylight / md-sal / sal-rest-connector / src / main / java / org / opendaylight / controller / sal / restconf / impl / ControllerContext.java
index 5f6604c68de3692343668266cadd4fcdb1e5a956..e3beaa2287d01f5734b50a467b4e5cdd47cfcf6f 100644 (file)
@@ -27,10 +27,10 @@ import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 import javax.ws.rs.core.Response.Status;
+import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationException;
 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizationOperation;
 import org.opendaylight.controller.md.sal.common.impl.util.compat.DataNormalizer;
 import org.opendaylight.controller.md.sal.dom.api.DOMMountPoint;
@@ -41,16 +41,15 @@ import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorTag;
 import org.opendaylight.controller.sal.restconf.impl.RestconfError.ErrorType;
 import org.opendaylight.yangtools.concepts.Codec;
 import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.CompositeNode;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.InstanceIdentifierBuilder;
 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.PathArgument;
-import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
-import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
+import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
@@ -84,6 +83,8 @@ public class ControllerContext implements SchemaContextListener {
 
     private static final Splitter SLASH_SPLITTER = Splitter.on('/');
 
+    private static final YangInstanceIdentifier ROOT = YangInstanceIdentifier.builder().build();
+
     private final AtomicReference<Map<QName, RpcDefinition>> qnameToRpc =
             new AtomicReference<>(Collections.<QName, RpcDefinition>emptyMap());
 
@@ -133,6 +134,10 @@ public class ControllerContext implements SchemaContextListener {
     private InstanceIdentifierContext toIdentifier(final String restconfInstance, final boolean toMountPointIdentifier) {
         checkPreconditions();
 
+        if(restconfInstance == null) {
+            return new InstanceIdentifierContext<>(ROOT, globalSchema, null, globalSchema);
+        }
+
         final List<String> pathArgs = urlPathArgsDecode(SLASH_SPLITTER.split(restconfInstance));
         omitFirstAndLastEmptyString(pathArgs);
         if (pathArgs.isEmpty()) {
@@ -251,24 +256,34 @@ public class ControllerContext implements SchemaContextListener {
         return node;
     }
 
-    public String toFullRestconfIdentifier(final YangInstanceIdentifier path) {
+    public String toFullRestconfIdentifier(final YangInstanceIdentifier path, final DOMMountPoint mount) {
         checkPreconditions();
 
         final Iterable<PathArgument> elements = path.getPathArguments();
         final StringBuilder builder = new StringBuilder();
         final PathArgument head = elements.iterator().next();
         final QName startQName = head.getNodeType();
-        final Module initialModule = globalSchema.findModuleByNamespaceAndRevision(startQName.getNamespace(),
+        final SchemaContext schemaContext;
+        if (mount != null) {
+            schemaContext = mount.getSchemaContext();
+        } else {
+            schemaContext = globalSchema;
+        }
+        final Module initialModule = schemaContext.findModuleByNamespaceAndRevision(startQName.getNamespace(),
                 startQName.getRevision());
         DataNodeContainer node = initialModule;
         for (final PathArgument element : elements) {
-            final QName _nodeType = element.getNodeType();
-            final DataSchemaNode potentialNode = ControllerContext.childByQName(node, _nodeType);
-            if (!ControllerContext.isListOrContainer(potentialNode)) {
-                return null;
+            if (!(element instanceof AugmentationIdentifier)) {
+                final QName _nodeType = element.getNodeType();
+                final DataSchemaNode potentialNode = ControllerContext.childByQName(node, _nodeType);
+                if (!(element instanceof NodeIdentifier && potentialNode instanceof ListSchemaNode)) {
+                    if (!ControllerContext.isListOrContainer(potentialNode)) {
+                        return null;
+                    }
+                    builder.append(convertToRestconfIdentifier(element, (DataNodeContainer) potentialNode, mount));
+                    node = (DataNodeContainer) potentialNode;
+                }
             }
-            node = ((DataNodeContainer) potentialNode);
-            builder.append(this.convertToRestconfIdentifier(element, node));
         }
 
         return builder.toString();
@@ -313,6 +328,18 @@ public class ControllerContext implements SchemaContextListener {
         return schema == null ? null : schema.getName() + ':' + qname.getLocalName();
     }
 
+    public CharSequence toRestconfIdentifier(final QName qname, final DOMMountPoint mount) {
+        final SchemaContext schema;
+        if (mount != null) {
+            schema = mount.getSchemaContext();
+        } else {
+            checkPreconditions();
+            schema = globalSchema;
+        }
+
+        return toRestconfIdentifier(schema, qname);
+    }
+
     public CharSequence toRestconfIdentifier(final QName qname) {
         checkPreconditions();
 
@@ -415,7 +442,7 @@ public class ControllerContext implements SchemaContextListener {
         return null;
     }
 
-    private static DataSchemaNode childByQName(final ChoiceNode container, final QName name) {
+    private static DataSchemaNode childByQName(final ChoiceSchemaNode container, final QName name) {
         for (final ChoiceCaseNode caze : container.getCases()) {
             final DataSchemaNode ret = ControllerContext.childByQName(caze, name);
             if (ret != null) {
@@ -450,8 +477,8 @@ public class ControllerContext implements SchemaContextListener {
         final DataSchemaNode ret = container.getDataChildByName(name);
         if (ret == null) {
             for (final DataSchemaNode node : container.getChildNodes()) {
-                if ((node instanceof ChoiceNode)) {
-                    final ChoiceNode choiceNode = ((ChoiceNode) node);
+                if ((node instanceof ChoiceSchemaNode)) {
+                    final ChoiceSchemaNode choiceNode = ((ChoiceSchemaNode) node);
                     final DataSchemaNode childByQName = ControllerContext.childByQName(choiceNode, name);
                     if (childByQName != null) {
                         return childByQName;
@@ -462,8 +489,9 @@ public class ControllerContext implements SchemaContextListener {
         return ret;
     }
 
-    private String toUriString(final Object object) throws UnsupportedEncodingException {
-        return object == null ? "" : URLEncoder.encode(object.toString(), ControllerContext.URI_ENCODING_CHAR_SET);
+    private String toUriString(final Object object, final LeafSchemaNode leafNode, final DOMMountPoint mount) throws UnsupportedEncodingException {
+        final Codec<Object, Object> codec = RestCodec.from(leafNode.getType(), mount);
+        return object == null ? "" : URLEncoder.encode(codec.serialize(object).toString(), ControllerContext.URI_ENCODING_CHAR_SET);
     }
 
     private InstanceIdentifierContext collectPathArguments(final InstanceIdentifierBuilder builder,
@@ -476,7 +504,7 @@ public class ControllerContext implements SchemaContextListener {
         }
 
         if (strings.isEmpty()) {
-            return new InstanceIdentifierContext(builder.toInstance(), ((DataSchemaNode) parentNode), mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
+            return createContext(builder.toInstance(), ((DataSchemaNode) parentNode), mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
         }
 
         final String head = strings.iterator().next();
@@ -498,7 +526,7 @@ public class ControllerContext implements SchemaContextListener {
                             ErrorType.APPLICATION, ErrorTag.OPERATION_NOT_SUPPORTED);
                 }
 
-                final YangInstanceIdentifier partialPath = builder.toInstance();
+                final YangInstanceIdentifier partialPath = dataNormalizer.toNormalized(builder.build());
                 final Optional<DOMMountPoint> mountOpt = mountService.getMountPoint(partialPath);
                 if (!mountOpt.isPresent()) {
                     LOG.debug("Instance identifier to missing mount point: {}", partialPath);
@@ -513,12 +541,7 @@ public class ControllerContext implements SchemaContextListener {
                             ErrorType.APPLICATION, ErrorTag.UNKNOWN_ELEMENT);
                 }
 
-                if (returnJustMountPoint) {
-                    final YangInstanceIdentifier instance = YangInstanceIdentifier.builder().toInstance();
-                    return new InstanceIdentifierContext(instance, mountPointSchema, mount,mountPointSchema);
-                }
-
-                if (strings.size() == 1) {
+                if (returnJustMountPoint || strings.size() == 1) {
                     final YangInstanceIdentifier instance = YangInstanceIdentifier.builder().toInstance();
                     return new InstanceIdentifierContext(instance, mountPointSchema, mount,mountPointSchema);
                 }
@@ -563,6 +586,15 @@ public class ControllerContext implements SchemaContextListener {
             }
 
             targetNode = findInstanceDataChildByNameAndNamespace(parentNode, nodeName, module.getNamespace());
+
+            if (targetNode == null && parentNode instanceof Module) {
+                final RpcDefinition rpc = ControllerContext.getInstance().getRpcDefinition(head);
+                if (rpc != null) {
+                    return new InstanceIdentifierContext<RpcDefinition>(builder.build(), rpc, mountPoint,
+                            mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
+                }
+            }
+
             if (targetNode == null) {
                 throw new RestconfDocumentedException("URI has bad format. Possible reasons:\n" + " 1. \"" + head
                         + "\" was not found in parent data node.\n" + " 2. \"" + head
@@ -637,7 +669,14 @@ public class ControllerContext implements SchemaContextListener {
                     returnJustMountPoint);
         }
 
-        return new InstanceIdentifierContext(builder.toInstance(), targetNode, mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
+        return createContext(builder.build(), targetNode, mountPoint,mountPoint != null ? mountPoint.getSchemaContext() : globalSchema);
+    }
+
+    private InstanceIdentifierContext createContext(final YangInstanceIdentifier instance, final DataSchemaNode dataSchemaNode,
+            final DOMMountPoint mountPoint, final SchemaContext schemaContext) {
+
+        final YangInstanceIdentifier instanceIdentifier = new DataNormalizer(schemaContext).toNormalized(instance);
+        return new InstanceIdentifierContext(instanceIdentifier, dataSchemaNode, mountPoint,schemaContext);
     }
 
     public static DataSchemaNode findInstanceDataChildByNameAndNamespace(final DataNodeContainer container, final String name,
@@ -666,9 +705,9 @@ public class ControllerContext implements SchemaContextListener {
         return instantiatedDataNodeContainers;
     }
 
-    private static final Function<ChoiceNode, Set<ChoiceCaseNode>> CHOICE_FUNCTION = new Function<ChoiceNode, Set<ChoiceCaseNode>>() {
+    private static final Function<ChoiceSchemaNode, Set<ChoiceCaseNode>> CHOICE_FUNCTION = new Function<ChoiceSchemaNode, Set<ChoiceCaseNode>>() {
         @Override
-        public Set<ChoiceCaseNode> apply(final ChoiceNode node) {
+        public Set<ChoiceCaseNode> apply(final ChoiceSchemaNode node) {
             return node.getCases();
         }
     };
@@ -693,7 +732,7 @@ public class ControllerContext implements SchemaContextListener {
             }
         }
 
-        final Iterable<ChoiceNode> choiceNodes = Iterables.filter(container.getChildNodes(), ChoiceNode.class);
+        final Iterable<ChoiceSchemaNode> choiceNodes = Iterables.filter(container.getChildNodes(), ChoiceSchemaNode.class);
         final Iterable<Set<ChoiceCaseNode>> map = Iterables.transform(choiceNodes, CHOICE_FUNCTION);
 
         final Iterable<ChoiceCaseNode> allCases = Iterables.<ChoiceCaseNode> concat(map);
@@ -823,11 +862,11 @@ public class ControllerContext implements SchemaContextListener {
         return null;
     }
 
-    private CharSequence convertToRestconfIdentifier(final PathArgument argument, final DataNodeContainer node) {
+    private CharSequence convertToRestconfIdentifier(final PathArgument argument, final DataNodeContainer node, final DOMMountPoint mount) {
         if (argument instanceof NodeIdentifier && node instanceof ContainerSchemaNode) {
-            return convertToRestconfIdentifier((NodeIdentifier) argument, (ContainerSchemaNode) node);
+            return convertToRestconfIdentifier((NodeIdentifier) argument, mount);
         } else if (argument instanceof NodeIdentifierWithPredicates && node instanceof ListSchemaNode) {
-            return convertToRestconfIdentifier((NodeIdentifierWithPredicates) argument, (ListSchemaNode) node);
+            return convertToRestconfIdentifierWithPredicates((NodeIdentifierWithPredicates) argument, (ListSchemaNode) node, mount);
         } else if (argument != null && node != null) {
             throw new IllegalArgumentException("Conversion of generic path argument is not supported");
         } else {
@@ -836,14 +875,14 @@ public class ControllerContext implements SchemaContextListener {
         }
     }
 
-    private CharSequence convertToRestconfIdentifier(final NodeIdentifier argument, final ContainerSchemaNode node) {
-        return "/" + this.toRestconfIdentifier(argument.getNodeType());
+    private CharSequence convertToRestconfIdentifier(final NodeIdentifier argument, final DOMMountPoint node) {
+        return "/" + this.toRestconfIdentifier(argument.getNodeType(),node);
     }
 
-    private CharSequence convertToRestconfIdentifier(final NodeIdentifierWithPredicates argument,
-            final ListSchemaNode node) {
+    private CharSequence convertToRestconfIdentifierWithPredicates(final NodeIdentifierWithPredicates argument,
+            final ListSchemaNode node, final DOMMountPoint mount) {
         final QName nodeType = argument.getNodeType();
-        final CharSequence nodeIdentifier = this.toRestconfIdentifier(nodeType);
+        final CharSequence nodeIdentifier = this.toRestconfIdentifier(nodeType, mount);
         final Map<QName, Object> keyValues = argument.getKeyValues();
 
         final StringBuilder builder = new StringBuilder();
@@ -854,17 +893,23 @@ public class ControllerContext implements SchemaContextListener {
         final List<QName> keyDefinition = node.getKeyDefinition();
         boolean hasElements = false;
         for (final QName key : keyDefinition) {
-            if (!hasElements) {
-                hasElements = true;
-            } else {
-                builder.append('/');
-            }
+            for (final DataSchemaNode listChild : node.getChildNodes()) {
+                if (listChild.getQName().equals(key)) {
+                    if (!hasElements) {
+                        hasElements = true;
+                    } else {
+                        builder.append('/');
+                    }
 
-            try {
-                builder.append(toUriString(keyValues.get(key)));
-            } catch (final UnsupportedEncodingException e) {
-                LOG.error("Error parsing URI: {}", keyValues.get(key), e);
-                return null;
+                    try {
+                        Preconditions.checkState(listChild instanceof LeafSchemaNode, "List key has to consist of leaves");
+                        builder.append(toUriString(keyValues.get(key), (LeafSchemaNode)listChild, mount));
+                    } catch (final UnsupportedEncodingException e) {
+                        LOG.error("Error parsing URI: {}", keyValues.get(key), e);
+                        return null;
+                    }
+                    break;
+                }
             }
         }
 
@@ -874,8 +919,8 @@ public class ControllerContext implements SchemaContextListener {
     private static DataSchemaNode childByQName(final Object container, final QName name) {
         if (container instanceof ChoiceCaseNode) {
             return childByQName((ChoiceCaseNode) container, name);
-        } else if (container instanceof ChoiceNode) {
-            return childByQName((ChoiceNode) container, name);
+        } else if (container instanceof ChoiceSchemaNode) {
+            return childByQName((ChoiceSchemaNode) container, name);
         } else if (container instanceof ContainerSchemaNode) {
             return childByQName((ContainerSchemaNode) container, name);
         } else if (container instanceof ListSchemaNode) {
@@ -890,30 +935,32 @@ public class ControllerContext implements SchemaContextListener {
         }
     }
 
-    public Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalized(final YangInstanceIdentifier legacy,
-            final CompositeNode compositeNode) {
+    public YangInstanceIdentifier toNormalized(final YangInstanceIdentifier legacy) {
         try {
-            return dataNormalizer.toNormalized(legacy, compositeNode);
+            return dataNormalizer.toNormalized(legacy);
         } catch (final NullPointerException e) {
             throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
         }
     }
 
-    public YangInstanceIdentifier toNormalized(final YangInstanceIdentifier legacy) {
+    public YangInstanceIdentifier toXpathRepresentation(final YangInstanceIdentifier instanceIdentifier) {
         try {
-            return dataNormalizer.toNormalized(legacy);
+            return dataNormalizer.toLegacy(instanceIdentifier);
         } catch (final NullPointerException e) {
             throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
+        } catch (final DataNormalizationException e) {
+            throw new RestconfDocumentedException("Data normalizer failed. Normalization isn't possible", e);
         }
     }
 
-    public CompositeNode toLegacy(final YangInstanceIdentifier instanceIdentifier,
-            final NormalizedNode<?,?> normalizedNode) {
+    public boolean isNodeMixin(final YangInstanceIdentifier path) {
+        final DataNormalizationOperation<?> operation;
         try {
-            return dataNormalizer.toLegacy(instanceIdentifier, normalizedNode);
-        } catch (final NullPointerException e) {
-            throw new RestconfDocumentedException("Data normalizer isn't set. Normalization isn't possible", e);
+            operation = dataNormalizer.getOperation(path);
+        } catch (final DataNormalizationException e) {
+            throw new RestconfDocumentedException("Data normalizer failed. Normalization isn't possible", e);
         }
+        return operation.isMixin();
     }
 
     public DataNormalizationOperation<?> getRootOperation() {