NetconfSessionPreferences is a record
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / listener / NetconfSessionPreferences.java
index dcff0f294b65791c5394fac8d13ead94913c8b02..ed2a4ef132ba9a74ebd514f1265f1648b6ca83ce 100644 (file)
@@ -5,51 +5,34 @@
  * 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.sal.connect.netconf.listener;
 
+import static java.util.Objects.requireNonNull;
+
 import com.google.common.base.MoreObjects;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
 import com.google.common.base.Predicate;
 import com.google.common.base.Splitter;
 import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.Iterables;
 import com.google.common.collect.Maps;
-import java.net.URI;
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Set;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
 import org.opendaylight.netconf.client.NetconfClientSession;
 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
 import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public final class NetconfSessionPreferences {
-
-    private static final class ParameterMatcher {
-        private final Predicate<String> predicate;
-        private final int skipLength;
-
-        ParameterMatcher(final String name) {
-            predicate = input -> input.startsWith(name);
-
-            this.skipLength = name.length();
-        }
-
-        private String from(final Iterable<String> params) {
-            final Optional<String> o = Iterables.tryFind(params, predicate);
-            if (!o.isPresent()) {
-                return null;
-            }
-
-            return o.get().substring(skipLength);
-        }
-    }
+// FIXME: propagate to API with immutable semantics
+public record NetconfSessionPreferences(
+        @NonNull ImmutableMap<String, CapabilityOrigin> nonModuleCaps,
+        @NonNull ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps) {
 
     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
@@ -58,34 +41,22 @@ public final class NetconfSessionPreferences {
     private static final Splitter AMP_SPLITTER = Splitter.on('&');
     private static final Predicate<String> CONTAINS_REVISION = input -> input.contains("revision=");
 
-    private final Map<QName, CapabilityOrigin> moduleBasedCaps;
-    private final Map<String, CapabilityOrigin> nonModuleCaps;
-
-    NetconfSessionPreferences(final Map<String, CapabilityOrigin> nonModuleCaps,
-                              final Map<QName, CapabilityOrigin> moduleBasedCaps) {
-        this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
-        this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
-    }
-
-    public Set<QName> getModuleBasedCaps() {
-        return moduleBasedCaps.keySet();
+    public NetconfSessionPreferences {
+        requireNonNull(nonModuleCaps);
+        requireNonNull(moduleBasedCaps);
     }
 
-    public Map<QName, CapabilityOrigin> getModuleBasedCapsOrigin() {
-        return moduleBasedCaps;
+    public @Nullable CapabilityOrigin capabilityOrigin(final QName capability) {
+        return moduleBasedCaps.get(requireNonNull(capability));
     }
 
-    public Set<String> getNonModuleCaps() {
-        return nonModuleCaps.keySet();
-    }
-
-    public Map<String, CapabilityOrigin> getNonModuleBasedCapsOrigin() {
-        return nonModuleCaps;
+    public @Nullable CapabilityOrigin capabilityOrigin(final String capability) {
+        return nonModuleCaps.get(requireNonNull(capability));
     }
 
     // allows partial matches - assuming parameters are in the same order
     public boolean containsPartialNonModuleCapability(final String capability) {
-        for (final String nonModuleCap : getNonModuleCaps()) {
+        for (var nonModuleCap : nonModuleCaps.keySet()) {
             if (nonModuleCap.startsWith(capability)) {
                 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
                 return true;
@@ -141,60 +112,53 @@ public final class NetconfSessionPreferences {
      * Merge module-based list of capabilities with current list of module-based capabilities.
      *
      * @param netconfSessionModuleCapabilities capabilities to merge into this
-     *
      * @return new instance of preferences with merged module-based capabilities
      */
     public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
-        final Map<QName, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(moduleBasedCaps.size()
-                + netconfSessionModuleCapabilities.getModuleBasedCaps().size());
+        final var mergedCaps = Maps.<QName, CapabilityOrigin>newHashMapWithExpectedSize(moduleBasedCaps.size()
+                + netconfSessionModuleCapabilities.moduleBasedCaps.size());
         mergedCaps.putAll(moduleBasedCaps);
-        mergedCaps.putAll(netconfSessionModuleCapabilities.getModuleBasedCapsOrigin());
-        return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), mergedCaps);
+        mergedCaps.putAll(netconfSessionModuleCapabilities.moduleBasedCaps);
+        return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(mergedCaps));
     }
 
     /**
      * Override current list of module-based capabilities.
      *
      * @param netconfSessionPreferences capabilities to override in this
-     *
      * @return new instance of preferences with replaced module-based capabilities
      */
     public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
-        return new NetconfSessionPreferences(
-                getNonModuleBasedCapsOrigin(), netconfSessionPreferences.getModuleBasedCapsOrigin());
+        return new NetconfSessionPreferences(nonModuleCaps, netconfSessionPreferences.moduleBasedCaps);
     }
 
     public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
-        return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), newModuleBasedCaps);
+        return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(newModuleBasedCaps));
     }
 
-
     /**
      * Merge list of non-module based capabilities with current list of non-module based capabilities.
      *
      * @param netconfSessionNonModuleCapabilities capabilities to merge into this
-     *
      * @return new instance of preferences with merged non-module based capabilities
      */
     public NetconfSessionPreferences addNonModuleCaps(
             final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
-        final Map<String, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(
-                nonModuleCaps.size() + netconfSessionNonModuleCapabilities.getNonModuleCaps().size());
-        mergedCaps.putAll(getNonModuleBasedCapsOrigin());
-        mergedCaps.putAll(netconfSessionNonModuleCapabilities.getNonModuleBasedCapsOrigin());
-        return new NetconfSessionPreferences(mergedCaps, getModuleBasedCapsOrigin());
+        final var mergedCaps = Maps.<String, CapabilityOrigin>newHashMapWithExpectedSize(
+                nonModuleCaps.size() + netconfSessionNonModuleCapabilities.nonModuleCaps.size());
+        mergedCaps.putAll(nonModuleCaps);
+        mergedCaps.putAll(netconfSessionNonModuleCapabilities.nonModuleCaps);
+        return new NetconfSessionPreferences(ImmutableMap.copyOf(mergedCaps), moduleBasedCaps);
     }
 
     /**
      * Override current list of non-module based capabilities.
      *
      * @param netconfSessionPreferences capabilities to override in this
-     *
      * @return new instance of preferences with replaced non-module based capabilities
      */
     public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
-        return new NetconfSessionPreferences(
-                netconfSessionPreferences.getNonModuleBasedCapsOrigin(), getModuleBasedCapsOrigin());
+        return new NetconfSessionPreferences(netconfSessionPreferences.nonModuleCaps, moduleBasedCaps);
     }
 
     public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
@@ -206,7 +170,7 @@ public final class NetconfSessionPreferences {
     }
 
     private static QName cachedQName(final String namespace, final String moduleName) {
-        return QName.create(URI.create(namespace), moduleName).withoutRevision().intern();
+        return QName.create(XMLNamespace.of(namespace), moduleName).withoutRevision().intern();
     }
 
     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
@@ -216,8 +180,8 @@ public final class NetconfSessionPreferences {
 
     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
                                                         final CapabilityOrigin capabilityOrigin) {
-        final Map<QName, CapabilityOrigin> moduleBasedCaps = new HashMap<>();
-        final Map<String, CapabilityOrigin> nonModuleCaps = new HashMap<>();
+        final var moduleBasedCaps = new HashMap<QName, CapabilityOrigin>();
+        final var nonModuleCaps = new HashMap<String, CapabilityOrigin>();
 
         for (final String capability : capabilities) {
             nonModuleCaps.put(capability, capabilityOrigin);
@@ -274,11 +238,21 @@ public final class NetconfSessionPreferences {
         nonModuleCaps.remove(capability);
     }
 
-    private final NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
-
-    public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {
-        return capabilities;
-    }
+    private static final class ParameterMatcher {
+        private final Predicate<String> predicate;
+        private final int skipLength;
 
+        ParameterMatcher(final String name) {
+            predicate = input -> input.startsWith(name);
+            skipLength = name.length();
+        }
 
+        String from(final Iterable<String> params) {
+            final var found = Iterables.tryFind(params, predicate);
+            if (!found.isPresent()) {
+                return null;
+            }
+            return found.get().substring(skipLength);
+        }
+    }
 }