opendaylight/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
   9 package org.opendaylight.netconf.sal.connect.netconf.listener;
  10
  11 import com.google.common.base.MoreObjects;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  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.ImmutableSet;
  18 import com.google.common.collect.Iterables;
  19 import com.google.common.collect.Sets;
  20 import java.net.URI;
  21 import java.util.Collection;
  22 import java.util.HashSet;
  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.yangtools.yang.common.QName;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 public final class NetconfSessionPreferences {
  31
  32     private static final class ParameterMatcher {
  33         private final Predicate<String> predicate;
  34         private final int skipLength;
  35
  36         ParameterMatcher(final String name) {
  37             predicate = new Predicate<String>() {
  38                 @Override
  39                 public boolean apply(final String input) {
  40                     return input.startsWith(name);
  41                 }
  42             };
  43
  44             this.skipLength = name.length();
  45         }
  46
  47         private String from(final Iterable<String> params) {
  48             final Optional<String> o = Iterables.tryFind(params, predicate);
  49             if (!o.isPresent()) {
  50                 return null;
  51             }
  52
  53             return o.get().substring(skipLength);
  54         }
  55     }
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
  58     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
  59     private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
  60     private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
  61     private static final Splitter AMP_SPLITTER = Splitter.on('&');
  62     private static final Predicate<String> CONTAINS_REVISION = new Predicate<String>() {
  63         @Override
  64         public boolean apply(final String input) {
  65             return input.contains("revision=");
  66         }
  67     };
  68
  69     private final Set<QName> moduleBasedCaps;
  70     private final Set<String> nonModuleCaps;
  71
  72     NetconfSessionPreferences(final Set<String> nonModuleCaps, final Set<QName> moduleBasedCaps) {
  73         this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
  74         this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
  75     }
  76
  77     public Set<QName> getModuleBasedCaps() {
  78         return moduleBasedCaps;
  79     }
  80
  81     public Set<String> getNonModuleCaps() {
  82         return nonModuleCaps;
  83     }
  84
  85     public boolean containsNonModuleCapability(final String capability) {
  86         return nonModuleCaps.contains(capability);
  87     }
  88
  89     public boolean containsModuleCapability(final QName capability) {
  90         return moduleBasedCaps.contains(capability);
  91     }
  92
  93     @Override
  94     public String toString() {
  95         return MoreObjects.toStringHelper(this)
  96                 .add("capabilities", nonModuleCaps)
  97                 .add("moduleBasedCapabilities", moduleBasedCaps)
  98                 .add("rollback", isRollbackSupported())
  99                 .add("monitoring", isMonitoringSupported())
 100                 .add("candidate", isCandidateSupported())
 101                 .add("writableRunning", isRunningWritable())
 102                 .toString();
 103     }
 104
 105     public boolean isRollbackSupported() {
 106         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
 107     }
 108
 109     public boolean isCandidateSupported() {
 110         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
 111     }
 112
 113     public boolean isRunningWritable() {
 114         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
 115     }
 116
 117     public boolean isNotificationsSupported() {
 118         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
 119                 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
 120     }
 121
 122     public boolean isMonitoringSupported() {
 123         return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
 124                 || containsNonModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
 125     }
 126
 127     /**
 128      * Merge module-based list of capabilities with current list of module-based capabilities
 129      *
 130      * @param netconfSessionModuleCapabilities capabilities to merge into this
 131      *
 132      * @return new instance of preferences with merged module-based capabilities
 133      */
 134     public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
 135         final HashSet<QName> mergedCaps = Sets.newHashSetWithExpectedSize(moduleBasedCaps.size() + netconfSessionModuleCapabilities.getModuleBasedCaps().size());
 136         mergedCaps.addAll(moduleBasedCaps);
 137         mergedCaps.addAll(netconfSessionModuleCapabilities.getModuleBasedCaps());
 138         return new NetconfSessionPreferences(getNonModuleCaps(), mergedCaps);
 139     }
 140
 141     /**
 142      * Override current list of module-based capabilities
 143      *
 144      * @param netconfSessionPreferences capabilities to override in this
 145      *
 146      * @return new instance of preferences with replaced module-based capabilities
 147      */
 148     public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
 149         return new NetconfSessionPreferences(getNonModuleCaps(), netconfSessionPreferences.getModuleBasedCaps());
 150     }
 151
 152     public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
 153         return fromStrings(session.getServerCapabilities());
 154     }
 155
 156     private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
 157         return QName.create(namespace, revision, moduleName).intern();
 158     }
 159
 160     private static QName cachedQName(final String namespace, final String moduleName) {
 161         return QName.create(URI.create(namespace), null, moduleName).withoutRevision().intern();
 162     }
 163
 164     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
 165         final Set<QName> moduleBasedCaps = new HashSet<>();
 166         final Set<String> nonModuleCaps = Sets.newHashSet(capabilities);
 167
 168         for (final String capability : capabilities) {
 169             final int qmark = capability.indexOf('?');
 170             if (qmark == -1) {
 171                 continue;
 172             }
 173
 174             final String namespace = capability.substring(0, qmark);
 175             final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
 176             final String moduleName = MODULE_PARAM.from(queryParams);
 177             if (Strings.isNullOrEmpty(moduleName)) {
 178                 continue;
 179             }
 180
 181             String revision = REVISION_PARAM.from(queryParams);
 182             if (!Strings.isNullOrEmpty(revision)) {
 183                 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
 184                 continue;
 185             }
 186
 187             /*
 188              * We have seen devices which mis-escape revision, but the revision may not
 189              * even be there. First check if there is a substring that matches revision.
 190              */
 191             if (Iterables.any(queryParams, CONTAINS_REVISION)) {
 192
 193                 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
 194                 revision = BROKEN_REVISON_PARAM.from(queryParams);
 195                 if (Strings.isNullOrEmpty(revision)) {
 196                     LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
 197                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
 198                 } else {
 199                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
 200                 }
 201                 continue;
 202             }
 203
 204             // Fallback, no revision provided for module
 205             addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
 206         }
 207
 208         return new NetconfSessionPreferences(ImmutableSet.copyOf(nonModuleCaps), ImmutableSet.copyOf(moduleBasedCaps));
 209     }
 210
 211
 212     private static void addModuleQName(final Set<QName> moduleBasedCaps, final Set<String> nonModuleCaps, final String capability, final QName qName) {
 213         moduleBasedCaps.add(qName);
 214         nonModuleCaps.remove(capability);
 215     }
 216
 217     private NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
 218
 219     public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {
 220         return capabilities;
 221     }
 222
 223
 224 }