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