netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/listener/NetconfSessionPreferences.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.netconf.sal.connect.netconf.listener;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.base.MoreObjects;
  13 import com.google.common.base.Optional;
  14 import com.google.common.base.Predicate;
  15 import com.google.common.base.Splitter;
  16 import com.google.common.base.Strings;
  17 import com.google.common.collect.ImmutableMap;
  18 import com.google.common.collect.Iterables;
  19 import com.google.common.collect.Maps;
  20 import java.util.Collection;
  21 import java.util.HashMap;
  22 import java.util.Map;
  23 import java.util.Set;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.opendaylight.netconf.client.NetconfClientSession;
  26 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
  28 import org.opendaylight.yangtools.yang.common.QName;
  29 import org.opendaylight.yangtools.yang.common.XMLNamespace;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 // FIXME: propagate to API with immutable semantics
  34 public final class NetconfSessionPreferences {
  35
  36     private static final class ParameterMatcher {
  37         private final Predicate<String> predicate;
  38         private final int skipLength;
  39
  40         ParameterMatcher(final String name) {
  41             predicate = input -> input.startsWith(name);
  42
  43             skipLength = name.length();
  44         }
  45
  46         String from(final Iterable<String> params) {
  47             final Optional<String> o = Iterables.tryFind(params, predicate);
  48             if (!o.isPresent()) {
  49                 return null;
  50             }
  51
  52             return o.get().substring(skipLength);
  53         }
  54     }
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
  57     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
  58     private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
  59     private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
  60     private static final Splitter AMP_SPLITTER = Splitter.on('&');
  61     private static final Predicate<String> CONTAINS_REVISION = input -> input.contains("revision=");
  62
  63     private final ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps;
  64     private final ImmutableMap<String, CapabilityOrigin> nonModuleCaps;
  65
  66     private NetconfSessionPreferences(final ImmutableMap<String, CapabilityOrigin> nonModuleCaps,
  67             final ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps) {
  68         this.nonModuleCaps = requireNonNull(nonModuleCaps);
  69         this.moduleBasedCaps = requireNonNull(moduleBasedCaps);
  70     }
  71
  72     public Set<QName> getModuleBasedCaps() {
  73         return moduleBasedCaps.keySet();
  74     }
  75
  76     public Map<QName, CapabilityOrigin> getModuleBasedCapsOrigin() {
  77         return moduleBasedCaps;
  78     }
  79
  80     public Set<String> getNonModuleCaps() {
  81         return nonModuleCaps.keySet();
  82     }
  83
  84     public Map<String, CapabilityOrigin> getNonModuleBasedCapsOrigin() {
  85         return nonModuleCaps;
  86     }
  87
  88     public @Nullable CapabilityOrigin capabilityOrigin(final QName capability) {
  89         return moduleBasedCaps.get(requireNonNull(capability));
  90     }
  91
  92     public @Nullable CapabilityOrigin capabilityOrigin(final String capability) {
  93         return nonModuleCaps.get(requireNonNull(capability));
  94     }
  95
  96     // allows partial matches - assuming parameters are in the same order
  97     public boolean containsPartialNonModuleCapability(final String capability) {
  98         for (final String nonModuleCap : getNonModuleCaps()) {
  99             if (nonModuleCap.startsWith(capability)) {
 100                 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
 101                 return true;
 102             }
 103         }
 104         return false;
 105     }
 106
 107     public boolean containsNonModuleCapability(final String capability) {
 108         return nonModuleCaps.containsKey(capability);
 109     }
 110
 111     public boolean containsModuleCapability(final QName capability) {
 112         return moduleBasedCaps.containsKey(capability);
 113     }
 114
 115     @Override
 116     public String toString() {
 117         return MoreObjects.toStringHelper(this)
 118                 .add("capabilities", nonModuleCaps)
 119                 .add("moduleBasedCapabilities", moduleBasedCaps)
 120                 .add("rollback", isRollbackSupported())
 121                 .add("monitoring", isMonitoringSupported())
 122                 .add("candidate", isCandidateSupported())
 123                 .add("writableRunning", isRunningWritable())
 124                 .toString();
 125     }
 126
 127     public boolean isRollbackSupported() {
 128         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
 129     }
 130
 131     public boolean isCandidateSupported() {
 132         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
 133     }
 134
 135     public boolean isRunningWritable() {
 136         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
 137     }
 138
 139     public boolean isNotificationsSupported() {
 140         return containsPartialNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
 141                 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
 142     }
 143
 144     public boolean isMonitoringSupported() {
 145         return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
 146                 || containsPartialNonModuleCapability(
 147                         NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
 148     }
 149
 150     /**
 151      * Merge module-based list of capabilities with current list of module-based capabilities.
 152      *
 153      * @param netconfSessionModuleCapabilities capabilities to merge into this
 154      * @return new instance of preferences with merged module-based capabilities
 155      */
 156     public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
 157         final var mergedCaps = Maps.<QName, CapabilityOrigin>newHashMapWithExpectedSize(moduleBasedCaps.size()
 158                 + netconfSessionModuleCapabilities.moduleBasedCaps.size());
 159         mergedCaps.putAll(moduleBasedCaps);
 160         mergedCaps.putAll(netconfSessionModuleCapabilities.moduleBasedCaps);
 161         return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(mergedCaps));
 162     }
 163
 164     /**
 165      * Override current list of module-based capabilities.
 166      *
 167      * @param netconfSessionPreferences capabilities to override in this
 168      * @return new instance of preferences with replaced module-based capabilities
 169      */
 170     public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
 171         return new NetconfSessionPreferences(nonModuleCaps, netconfSessionPreferences.moduleBasedCaps);
 172     }
 173
 174     public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
 175         return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(newModuleBasedCaps));
 176     }
 177
 178     /**
 179      * Merge list of non-module based capabilities with current list of non-module based capabilities.
 180      *
 181      * @param netconfSessionNonModuleCapabilities capabilities to merge into this
 182      * @return new instance of preferences with merged non-module based capabilities
 183      */
 184     public NetconfSessionPreferences addNonModuleCaps(
 185             final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
 186         final var mergedCaps = Maps.<String, CapabilityOrigin>newHashMapWithExpectedSize(
 187                 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.nonModuleCaps.size());
 188         mergedCaps.putAll(nonModuleCaps);
 189         mergedCaps.putAll(netconfSessionNonModuleCapabilities.nonModuleCaps);
 190         return new NetconfSessionPreferences(ImmutableMap.copyOf(mergedCaps), moduleBasedCaps);
 191     }
 192
 193     /**
 194      * Override current list of non-module based capabilities.
 195      *
 196      * @param netconfSessionPreferences capabilities to override in this
 197      * @return new instance of preferences with replaced non-module based capabilities
 198      */
 199     public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
 200         return new NetconfSessionPreferences(netconfSessionPreferences.nonModuleCaps, moduleBasedCaps);
 201     }
 202
 203     public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
 204         return fromStrings(session.getServerCapabilities());
 205     }
 206
 207     private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
 208         return QName.create(namespace, revision, moduleName).intern();
 209     }
 210
 211     private static QName cachedQName(final String namespace, final String moduleName) {
 212         return QName.create(XMLNamespace.of(namespace), moduleName).withoutRevision().intern();
 213     }
 214
 215     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
 216         // we do not know origin of capabilities from only Strings, so we set it to default value
 217         return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised);
 218     }
 219
 220     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
 221                                                         final CapabilityOrigin capabilityOrigin) {
 222         final var moduleBasedCaps = new HashMap<QName, CapabilityOrigin>();
 223         final var nonModuleCaps = new HashMap<String, CapabilityOrigin>();
 224
 225         for (final String capability : capabilities) {
 226             nonModuleCaps.put(capability, capabilityOrigin);
 227             final int qmark = capability.indexOf('?');
 228             if (qmark == -1) {
 229                 continue;
 230             }
 231
 232             final String namespace = capability.substring(0, qmark);
 233             final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
 234             final String moduleName = MODULE_PARAM.from(queryParams);
 235             if (Strings.isNullOrEmpty(moduleName)) {
 236                 continue;
 237             }
 238
 239             String revision = REVISION_PARAM.from(queryParams);
 240             if (!Strings.isNullOrEmpty(revision)) {
 241                 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName),
 242                         capabilityOrigin);
 243                 continue;
 244             }
 245
 246             /*
 247              * We have seen devices which mis-escape revision, but the revision may not
 248              * even be there. First check if there is a substring that matches revision.
 249              */
 250             if (Iterables.any(queryParams, CONTAINS_REVISION)) {
 251
 252                 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
 253                 revision = BROKEN_REVISON_PARAM.from(queryParams);
 254                 if (Strings.isNullOrEmpty(revision)) {
 255                     LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
 256                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 257                             cachedQName(namespace, moduleName), capabilityOrigin);
 258                 } else {
 259                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 260                             cachedQName(namespace, revision, moduleName), capabilityOrigin);
 261                 }
 262                 continue;
 263             }
 264
 265             // Fallback, no revision provided for module
 266             addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
 267                     cachedQName(namespace, moduleName), capabilityOrigin);
 268         }
 269
 270         return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps));
 271     }
 272
 273     private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps,
 274                                        final Map<String, CapabilityOrigin> nonModuleCaps, final String capability,
 275                                        final QName qualifiedName, final CapabilityOrigin capabilityOrigin) {
 276         moduleBasedCaps.put(qualifiedName, capabilityOrigin);
 277         nonModuleCaps.remove(capability);
 278     }
 279 }