Integrate netconf-mapping-api into netconf-server
[netconf.git] / netconf / mdsal-netconf-connector / src / main / java / org / opendaylight / netconf / mdsal / connector / ops / RuntimeRpc.java
index 3321b269fbfed5e387e1f87598f5393ce553b80d..ec8951e257f50e34c6ba7b3699cc5aae0c3d6484 100644 (file)
@@ -5,61 +5,56 @@
  * 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.netconf.mdsal.connector.ops;
 
-import com.google.common.base.Optional;
-import com.google.common.base.Throwables;
-import com.google.common.util.concurrent.CheckedFuture;
 import java.io.IOException;
-import java.net.URI;
-import java.util.Collection;
-import java.util.Collections;
+import java.net.URISyntaxException;
 import java.util.Map;
-import javax.annotation.Nullable;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
 import javax.xml.stream.XMLOutputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
 import javax.xml.transform.dom.DOMResult;
-import org.opendaylight.controller.config.util.xml.DocumentedException;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.config.util.xml.XmlMappingConstants;
-import org.opendaylight.controller.config.util.xml.XmlUtil;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcException;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
-import org.opendaylight.controller.md.sal.dom.api.DOMRpcService;
+import javax.xml.transform.dom.DOMSource;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.netconf.api.DocumentedException;
+import org.opendaylight.netconf.api.NetconfDocumentedException;
+import org.opendaylight.netconf.api.xml.XmlElement;
 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
-import org.opendaylight.netconf.mapping.api.HandlingPriority;
-import org.opendaylight.netconf.mapping.api.NetconfOperationChainedExecution;
+import org.opendaylight.netconf.api.xml.XmlUtil;
 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
-import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
+import org.opendaylight.netconf.server.api.operations.AbstractSingletonNetconfOperation;
+import org.opendaylight.netconf.server.api.operations.HandlingPriority;
+import org.opendaylight.netconf.server.api.operations.NetconfOperationChainedExecution;
+import org.opendaylight.yangtools.yang.common.ErrorSeverity;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
-import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
+import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
+import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter;
-import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
-import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.Module;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.w3c.dom.Attr;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
-import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
 
 public class RuntimeRpc extends AbstractSingletonNetconfOperation {
-
     private static final Logger LOG = LoggerFactory.getLogger(RuntimeRpc.class);
-
     private static final XMLOutputFactory XML_OUTPUT_FACTORY;
 
     static {
@@ -79,17 +74,16 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation {
 
     @Override
     protected HandlingPriority canHandle(final String netconfOperationName, final String namespace) {
-        final URI namespaceURI = createNsUri(namespace);
-        final Optional<Module> module = getModule(namespaceURI);
+        final XMLNamespace namespaceURI = createNsUri(namespace);
+        final Optional<? extends Module> module = getModule(namespaceURI);
 
-        if (!module.isPresent()) {
+        if (module.isEmpty()) {
             LOG.debug("Cannot handle rpc: {}, {}", netconfOperationName, namespace);
             return HandlingPriority.CANNOT_HANDLE;
         }
 
-        getRpcDefinitionFromModule(module.get(), namespaceURI, netconfOperationName);
+        getRpcDefinitionFromModule(module.orElseThrow(), namespaceURI, netconfOperationName);
         return HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY;
-
     }
 
     @Override
@@ -97,26 +91,24 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation {
         throw new UnsupportedOperationException("Runtime rpc does not have a stable name");
     }
 
-    private static URI createNsUri(final String namespace) {
+    private static XMLNamespace createNsUri(final String namespace) {
         // May throw IllegalArgumentException, but that should never happen, as the namespace comes from parsed XML
-        return URI.create(namespace);
+        return XMLNamespace.of(namespace);
     }
 
     //this returns module with the newest revision if more then 1 module with same namespace is found
-    private Optional<Module> getModule(final URI namespaceURI) {
-        return Optional.fromNullable(
-                schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(namespaceURI, null));
+    private Optional<? extends Module> getModule(final XMLNamespace namespace) {
+        return schemaContext.getCurrentContext().findModules(namespace).stream().findFirst();
     }
 
-    private static Optional<RpcDefinition> getRpcDefinitionFromModule(final Module module, final URI namespaceURI,
+    private static Optional<RpcDefinition> getRpcDefinitionFromModule(final Module module, final XMLNamespace namespace,
             final String name) {
         for (final RpcDefinition rpcDef : module.getRpcs()) {
-            if (rpcDef.getQName().getNamespace().equals(namespaceURI)
-                    && rpcDef.getQName().getLocalName().equals(name)) {
+            if (rpcDef.getQName().getNamespace().equals(namespace) && rpcDef.getQName().getLocalName().equals(name)) {
                 return Optional.of(rpcDef);
             }
         }
-        return Optional.absent();
+        return Optional.empty();
     }
 
     @Override
@@ -129,59 +121,56 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation {
             netconfOperationNamespace = operationElement.getNamespace();
         } catch (final DocumentedException e) {
             LOG.debug("Cannot retrieve netconf operation namespace from message due to ", e);
-            throw new DocumentedException("Cannot retrieve netconf operation namespace from message",
+            throw new DocumentedException("Cannot retrieve netconf operation namespace from message", e,
                     ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
         }
 
-        final URI namespaceURI = createNsUri(netconfOperationNamespace);
-        final Optional<Module> moduleOptional = getModule(namespaceURI);
+        final XMLNamespace namespaceURI = createNsUri(netconfOperationNamespace);
+        final Optional<? extends Module> moduleOptional = getModule(namespaceURI);
 
-        if (!moduleOptional.isPresent()) {
+        if (moduleOptional.isEmpty()) {
             throw new DocumentedException("Unable to find module in Schema Context with namespace and name : "
                         + namespaceURI + " " + netconfOperationName + schemaContext.getCurrentContext(),
                     ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR);
         }
 
-        final Optional<RpcDefinition> rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.get(),
+        final Optional<RpcDefinition> rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.orElseThrow(),
                 namespaceURI, netconfOperationName);
 
-        if (!rpcDefinitionOptional.isPresent()) {
+        if (rpcDefinitionOptional.isEmpty()) {
             throw new DocumentedException(
                     "Unable to find RpcDefinition with namespace and name : "
                         + namespaceURI + " " + netconfOperationName,
                     ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR);
         }
 
-        final RpcDefinition rpcDefinition = rpcDefinitionOptional.get();
-        final SchemaPath schemaPath = SchemaPath.create(Collections.singletonList(rpcDefinition.getQName()), true);
-        final NormalizedNode<?, ?> inputNode = rpcToNNode(operationElement, rpcDefinition.getInput());
+        final RpcDefinition rpcDefinition = rpcDefinitionOptional.orElseThrow();
+        final ContainerNode inputNode = rpcToNNode(operationElement, rpcDefinition);
 
-        final CheckedFuture<DOMRpcResult, DOMRpcException> rpcFuture = rpcService.invokeRpc(schemaPath, inputNode);
+        final DOMRpcResult result;
         try {
-            final DOMRpcResult result = rpcFuture.checkedGet();
-            if (result.getResult() == null) {
-                return XmlUtil.createElement(document, XmlNetconfConstants.OK,
-                        Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
-            }
-            return (Element) transformNormalizedNode(document, result.getResult(), rpcDefinition.getOutput().getPath());
-        } catch (final DOMRpcException e) {
+            result = rpcService.invokeRpc(rpcDefinition.getQName(), inputNode).get();
+        } catch (final InterruptedException | ExecutionException e) {
             throw DocumentedException.wrap(e);
         }
+        if (result.value() == null) {
+            return XmlUtil.createElement(document, XmlNetconfConstants.OK,
+                Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
+        }
+        return transformNormalizedNode(document, result.value(),
+                Absolute.of(rpcDefinition.getQName(), rpcDefinition.getOutput().getQName()));
     }
 
     @Override
-    public Document handle(final Document requestMessage,
-                           final NetconfOperationChainedExecution subsequentOperation) throws DocumentedException {
-
+    public Document handle(final Document requestMessage, final NetconfOperationChainedExecution subsequentOperation)
+            throws DocumentedException {
         final XmlElement requestElement = getRequestElementWithCheck(requestMessage);
-
         final Document document = XmlUtil.newDocument();
-
         final XmlElement operationElement = requestElement.getOnlyChildElement();
         final Map<String, Attr> attributes = requestElement.getAttributes();
 
         final Element response = handle(document, operationElement, subsequentOperation);
-        final Element rpcReply = XmlUtil.createElement(document, XmlMappingConstants.RPC_REPLY_KEY,
+        final Element rpcReply = XmlUtil.createElement(document, XmlNetconfConstants.RPC_REPLY_KEY,
                 Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
 
         if (XmlElement.fromDomElement(response).hasNamespace()) {
@@ -204,46 +193,47 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation {
         return document;
     }
 
-    private Node transformNormalizedNode(final Document document, final NormalizedNode<?, ?> data,
-                                         final SchemaPath rpcOutputPath) {
-        final DOMResult result = new DOMResult(document.createElement(XmlMappingConstants.RPC_REPLY_KEY));
+    private Element transformNormalizedNode(final Document document, final NormalizedNode data,
+                                            final Absolute rpcOutputPath) {
+        final DOMResult result = new DOMResult(document.createElement(XmlNetconfConstants.RPC_REPLY_KEY));
 
         final XMLStreamWriter xmlWriter = getXmlStreamWriter(result);
 
         final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter,
                 schemaContext.getCurrentContext(), rpcOutputPath);
 
-        final SchemaOrderedNormalizedNodeWriter nnWriter =
-                new SchemaOrderedNormalizedNodeWriter(nnStreamWriter, schemaContext.getCurrentContext(), rpcOutputPath);
+        final SchemaOrderedNormalizedNodeWriter nnWriter = new SchemaOrderedNormalizedNodeWriter(nnStreamWriter,
+                schemaContext.getCurrentContext(), rpcOutputPath);
 
         writeRootElement(xmlWriter, nnWriter, (ContainerNode) data);
         try {
             nnStreamWriter.close();
             xmlWriter.close();
         } catch (IOException | XMLStreamException e) {
+            // FIXME: throw DocumentedException
             LOG.warn("Error while closing streams", e);
         }
 
-        return result.getNode();
+        return (Element) result.getNode();
     }
 
     private static XMLStreamWriter getXmlStreamWriter(final DOMResult result) {
         try {
             return XML_OUTPUT_FACTORY.createXMLStreamWriter(result);
         } catch (final XMLStreamException e) {
-            throw new RuntimeException(e);
+            throw new IllegalStateException(e);
         }
     }
 
     private static void writeRootElement(final XMLStreamWriter xmlWriter,
             final SchemaOrderedNormalizedNodeWriter nnWriter, final ContainerNode data) {
         try {
-            final Collection<DataContainerChild<?, ?>> value = data.getValue();
-            nnWriter.write(value);
+            nnWriter.write(data.body());
             nnWriter.flush();
             xmlWriter.flush();
         } catch (XMLStreamException | IOException e) {
-            Throwables.propagate(e);
+            // FIXME: throw DocumentedException
+            throw new IllegalStateException(e);
         }
     }
 
@@ -251,15 +241,24 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation {
      * Parses xml element rpc input into normalized node or null if rpc does not take any input.
      *
      * @param element rpc xml element
-     * @param input   input container schema node, or null if rpc does not take any input
+     * @param rpcDefinition   input container schema node, or null if rpc does not take any input
      * @return parsed rpc into normalized node, or null if input schema is null
      */
-    @Nullable
-    private NormalizedNode<?, ?> rpcToNNode(final XmlElement element, @Nullable final ContainerSchemaNode input) {
-        return input.getChildNodes().isEmpty() ? null : DomToNormalizedNodeParserFactory
-                .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext.getCurrentContext())
-                .getContainerNodeParser()
-                .parse(Collections.singletonList(element.getDomElement()), input);
-    }
+    private @Nullable ContainerNode rpcToNNode(final XmlElement element,
+            final RpcDefinition rpcDefinition) throws DocumentedException {
+        final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
+        final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
+        final XmlParserStream xmlParser = XmlParserStream.create(writer, SchemaInferenceStack.of(
+            schemaContext.getCurrentContext(),
+            Absolute.of(rpcDefinition.getQName(), rpcDefinition.getInput().getQName())).toInference());
 
+        try {
+            xmlParser.traverse(new DOMSource(element.getDomElement()));
+        } catch (final XMLStreamException | URISyntaxException | IOException | SAXException ex) {
+            throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex,
+                ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR);
+        }
+
+        return (ContainerNode) resultHolder.getResult();
+    }
 }