Split up MessageTransformer
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / LibraryModulesSchemas.java
index ae21d80753688ccc2d29d90b479f0ffcc7a0d422..c7b7fc2f13c82526d431982815ff3c560f61a6f3 100644 (file)
@@ -10,10 +10,9 @@ package org.opendaylight.netconf.sal.connect.netconf;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkState;
 import static java.util.Objects.requireNonNull;
-import static javax.xml.bind.DatatypeConverter.printBase64Binary;
 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_DATA_NODEID;
 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_NODEID;
-import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_PATH;
+import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_GET_QNAME;
 
 import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableMap;
@@ -23,13 +22,13 @@ import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.net.HttpURLConnection;
 import java.net.MalformedURLException;
-import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.URLConnection;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.AbstractMap.SimpleImmutableEntry;
+import java.util.Base64;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
@@ -41,18 +40,21 @@ import java.util.regex.Pattern;
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.transform.dom.DOMSource;
+import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
-import org.opendaylight.binding.runtime.spi.BindingRuntimeHelpers;
+import org.opendaylight.mdsal.binding.runtime.spi.BindingRuntimeHelpers;
 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
 import org.opendaylight.netconf.sal.connect.api.NetconfDeviceSchemas;
 import org.opendaylight.netconf.sal.connect.netconf.sal.NetconfDeviceRpc;
 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.ModulesState;
-import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev160621.module.list.Module;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.ModulesState;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.YangLibrary;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.library.rev190104.module.list.Module;
 import org.opendaylight.yangtools.util.xml.UntrustedXML;
 import org.opendaylight.yangtools.yang.common.QName;
 import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
@@ -70,8 +72,9 @@ import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
-import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
@@ -88,8 +91,11 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
     private static final Logger LOG = LoggerFactory.getLogger(LibraryModulesSchemas.class);
     private static final Pattern DATE_PATTERN = Pattern.compile("(\\d{4}-\\d{2}-\\d{2})");
     private static final EffectiveModelContext LIBRARY_CONTEXT = BindingRuntimeHelpers.createEffectiveModel(
-        ModulesState.class);
+        YangLibrary.class);
+    private static final Inference MODULES_STATE_INFERENCE =
+        SchemaInferenceStack.ofDataTreePath(LIBRARY_CONTEXT, ModulesState.QNAME).toInference();
 
+    // FIXME: this is legacy RFC7895, add support for RFC8525 containers, too
     private static final NodeIdentifier MODULES_STATE_NID = NodeIdentifier.create(ModulesState.QNAME);
     private static final NodeIdentifier MODULE_NID = NodeIdentifier.create(Module.QNAME);
     private static final NodeIdentifier NAME_NID = NodeIdentifier.create(QName.create(Module.QNAME, "name").intern());
@@ -106,7 +112,7 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
     private static final YangInstanceIdentifier MODULES_STATE_MODULE_LIST =
             YangInstanceIdentifier.create(MODULES_STATE_NID, MODULE_NID);
 
-    private static final ContainerNode GET_MODULES_STATE_MODULE_LIST_RPC = Builders.containerBuilder()
+    private static final @NonNull ContainerNode GET_MODULES_STATE_MODULE_LIST_RPC = Builders.containerBuilder()
             .withNodeIdentifier(NETCONF_GET_NODEID)
             .withChild(NetconfMessageTransformUtil.toFilterStructure(MODULES_STATE_MODULE_LIST, LIBRARY_CONTEXT))
             .build();
@@ -120,8 +126,8 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
     public Map<SourceIdentifier, URL> getAvailableModels() {
         final Map<SourceIdentifier, URL> result = new HashMap<>();
         for (final Entry<QName, URL> entry : availableModels.entrySet()) {
-            final SourceIdentifier sId = RevisionSourceIdentifier.create(entry.getKey().getLocalName(),
-                entry.getKey().getRevision());
+            final SourceIdentifier sId = new SourceIdentifier(entry.getKey().getLocalName(),
+                entry.getKey().getRevision().map(Revision::toString).orElse(null));
             result.put(sId, entry.getValue());
         }
 
@@ -142,9 +148,8 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
             if (connection instanceof HttpURLConnection) {
                 connection.setRequestProperty("Accept", "application/xml");
                 final String userpass = username + ":" + password;
-                final String basicAuth = "Basic " + printBase64Binary(userpass.getBytes(StandardCharsets.UTF_8));
-
-                connection.setRequestProperty("Authorization", basicAuth);
+                connection.setRequestProperty("Authorization",
+                    "Basic " + Base64.getEncoder().encodeToString(userpass.getBytes(StandardCharsets.UTF_8)));
             }
 
             return createFromURLConnection(connection);
@@ -160,10 +165,10 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         final DOMRpcResult moduleListNodeResult;
         try {
             moduleListNodeResult =
-                    deviceRpc.invokeRpc(NETCONF_GET_PATH, GET_MODULES_STATE_MODULE_LIST_RPC).get();
+                    deviceRpc.invokeRpc(NETCONF_GET_QNAME, GET_MODULES_STATE_MODULE_LIST_RPC).get();
         } catch (final InterruptedException e) {
             Thread.currentThread().interrupt();
-            throw new RuntimeException(deviceId + ": Interrupted while waiting for response to "
+            throw new IllegalStateException(deviceId + ": Interrupted while waiting for response to "
                     + MODULES_STATE_MODULE_LIST, e);
         } catch (final ExecutionException e) {
             LOG.warn("{}: Unable to detect available schemas, get to {} failed", deviceId,
@@ -177,10 +182,10 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
             return new LibraryModulesSchemas(ImmutableMap.of());
         }
 
-        final Optional<? extends NormalizedNode<?, ?>> modulesStateNode =
+        final Optional<DataContainerChild> modulesStateNode =
                 findModulesStateNode(moduleListNodeResult.getResult());
         if (modulesStateNode.isPresent()) {
-            final NormalizedNode<?, ?> node = modulesStateNode.get();
+            final DataContainerChild node = modulesStateNode.get();
             checkState(node instanceof ContainerNode, "Expecting container containing schemas, but was %s", node);
             return create((ContainerNode) node);
         }
@@ -190,14 +195,14 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
     }
 
     private static LibraryModulesSchemas create(final ContainerNode modulesStateNode) {
-        final Optional<DataContainerChild<?, ?>> moduleListNode = modulesStateNode.getChild(MODULE_NID);
+        final Optional<DataContainerChild> moduleListNode = modulesStateNode.findChildByArg(MODULE_NID);
         checkState(moduleListNode.isPresent(), "Unable to find list: %s in %s", MODULE_NID, modulesStateNode);
-        final DataContainerChild<?, ?> node = moduleListNode.get();
+        final DataContainerChild node = moduleListNode.get();
         checkState(node instanceof MapNode, "Unexpected structure for container: %s in : %s. Expecting a list",
             MODULE_NID, modulesStateNode);
 
         final MapNode moduleList = (MapNode) node;
-        final Collection<MapEntryNode> modules = moduleList.getValue();
+        final Collection<MapEntryNode> modules = moduleList.body();
         final ImmutableMap.Builder<QName, URL> schemasMapping = ImmutableMap.builderWithExpectedSize(modules.size());
         for (final MapEntryNode moduleNode : modules) {
             final Entry<QName, URL> entry = createFromEntry(moduleNode);
@@ -229,17 +234,16 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         return createFromURLConnection(connection);
     }
 
-    private static Optional<? extends NormalizedNode<?, ?>> findModulesStateNode(final NormalizedNode<?, ?> result) {
+    private static Optional<DataContainerChild> findModulesStateNode(final NormalizedNode result) {
         if (result == null) {
             return Optional.empty();
         }
-        final Optional<DataContainerChild<?, ?>> dataNode =
-                ((DataContainerNode<?>) result).getChild(NETCONF_DATA_NODEID);
-        if (dataNode.isPresent() == false) {
+        final Optional<DataContainerChild> dataNode = ((DataContainerNode) result).findChildByArg(NETCONF_DATA_NODEID);
+        if (dataNode.isEmpty()) {
             return Optional.empty();
         }
 
-        return ((DataContainerNode<?>) dataNode.get()).getChild(MODULES_STATE_NID);
+        return ((DataContainerNode) dataNode.get()).findChildByArg(MODULES_STATE_NID);
     }
 
     private static LibraryModulesSchemas createFromURLConnection(final URLConnection connection) {
@@ -255,18 +259,18 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         checkState(contentType.equals("application/json") || contentType.equals("application/xml"),
                 "Only XML and JSON types are supported.");
 
-        Optional<NormalizedNode<?, ?>> optionalModulesStateNode = Optional.empty();
+        Optional<NormalizedNode> optionalModulesStateNode = Optional.empty();
         try (InputStream in = connection.getInputStream()) {
             optionalModulesStateNode = contentType.equals("application/json") ? readJson(in) : readXml(in);
         } catch (final IOException e) {
             LOG.warn("Unable to download yang library from {}", connection.getURL(), e);
         }
 
-        if (!optionalModulesStateNode.isPresent()) {
+        if (optionalModulesStateNode.isEmpty()) {
             return new LibraryModulesSchemas(ImmutableMap.of());
         }
 
-        final NormalizedNode<?, ?> modulesStateNode = optionalModulesStateNode.get();
+        final NormalizedNode modulesStateNode = optionalModulesStateNode.get();
         checkState(modulesStateNode instanceof ContainerNode, "Expecting container containing module list, but was %s",
             modulesStateNode);
         final ContainerNode modulesState = (ContainerNode) modulesStateNode;
@@ -281,7 +285,7 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         return i != 1 && ".json".equalsIgnoreCase(fileName.substring(i));
     }
 
-    private static Optional<NormalizedNode<?, ?>> readJson(final InputStream in) {
+    private static Optional<NormalizedNode> readJson(final InputStream in) {
         final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
         final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 
@@ -293,7 +297,7 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         return resultHolder.isFinished() ? Optional.of(resultHolder.getResult()) : Optional.empty();
     }
 
-    private static Optional<NormalizedNode<?, ?>> readXml(final InputStream in) {
+    private static Optional<NormalizedNode> readXml(final InputStream in) {
         try {
             final DocumentBuilder docBuilder = UntrustedXML.newDocumentBuilder();
 
@@ -316,11 +320,9 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
 
             final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
             final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
-            final XmlParserStream xmlParser = XmlParserStream.create(writer, LIBRARY_CONTEXT,
-                    LIBRARY_CONTEXT.getDataChildByName(ModulesState.QNAME));
+            final XmlParserStream xmlParser = XmlParserStream.create(writer, MODULES_STATE_INFERENCE);
             xmlParser.traverse(new DOMSource(doc.getDocumentElement()));
-            final NormalizedNode<?, ?> parsed = resultHolder.getResult();
-            return Optional.of(parsed);
+            return Optional.of(resultHolder.getResult());
         } catch (XMLStreamException | URISyntaxException | IOException | SAXException e) {
             LOG.warn("Unable to parse yang library xml content", e);
         }
@@ -329,7 +331,8 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
     }
 
     private static @Nullable Entry<QName, URL> createFromEntry(final MapEntryNode moduleNode) {
-        checkArgument(moduleNode.getNodeType().equals(Module.QNAME), "Wrong QName %s", moduleNode.getNodeType());
+        final QName moduleNodeId = moduleNode.getIdentifier().getNodeType();
+        checkArgument(moduleNodeId.equals(Module.QNAME), "Wrong QName %s", moduleNodeId);
 
         final String moduleName = getSingleChildNodeValue(moduleNode, NAME_NID).get();
         final Optional<String> revision = getSingleChildNodeValue(moduleNode, REVISION_NID);
@@ -347,7 +350,7 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
 
         final QName moduleQName = revision.isPresent()
                 ? QName.create(moduleNameSpace, revision.get(), moduleName)
-                : QName.create(URI.create(moduleNameSpace), moduleName);
+                : QName.create(XMLNamespace.of(moduleNameSpace), moduleName);
 
         try {
             return new SimpleImmutableEntry<>(moduleQName, new URL(schemaUriAsString.get()));
@@ -358,15 +361,15 @@ public final class LibraryModulesSchemas implements NetconfDeviceSchemas {
         }
     }
 
-    private static Optional<String> getSingleChildNodeValue(final DataContainerNode<?> schemaNode,
+    private static Optional<String> getSingleChildNodeValue(final DataContainerNode schemaNode,
                                                             final NodeIdentifier childNodeId) {
-        final Optional<DataContainerChild<?, ?>> node = schemaNode.getChild(childNodeId);
+        final Optional<DataContainerChild> node = schemaNode.findChildByArg(childNodeId);
         checkArgument(node.isPresent(), "Child node %s not present", childNodeId.getNodeType());
         return getValueOfSimpleNode(node.get());
     }
 
-    private static Optional<String> getValueOfSimpleNode(final NormalizedNode<?, ?> node) {
-        final String valueStr = node.getValue().toString();
+    private static Optional<String> getValueOfSimpleNode(final NormalizedNode node) {
+        final String valueStr = node.body().toString();
         return Strings.isNullOrEmpty(valueStr) ? Optional.empty() : Optional.of(valueStr.trim());
     }