opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/listener/NetconfSessionCapabilities.java

   1 package org.opendaylight.controller.sal.connect.netconf.listener;
   2
   3 import com.google.common.base.Objects;
   4 import com.google.common.base.Optional;
   5 import com.google.common.base.Preconditions;
   6 import com.google.common.base.Predicate;
   7 import com.google.common.base.Splitter;
   8 import com.google.common.collect.ImmutableSet;
   9 import com.google.common.collect.Iterables;
  10
  11 import java.util.Collection;
  12 import java.util.HashSet;
  13 import java.util.Set;
  14
  15 import org.opendaylight.controller.netconf.client.NetconfClientSession;
  16 import org.opendaylight.controller.sal.connect.netconf.util.NetconfMessageTransformUtil;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.slf4j.Logger;
  19 import org.slf4j.LoggerFactory;
  20
  21 public final class NetconfSessionCapabilities {
  22     private static final class ParameterMatcher {
  23         private final Predicate<String> predicate;
  24         private final int skipLength;
  25
  26         ParameterMatcher(final String name) {
  27             predicate = new Predicate<String>() {
  28                 @Override
  29                 public boolean apply(final String input) {
  30                     return input.startsWith(name);
  31                 }
  32             };
  33
  34             this.skipLength = name.length();
  35         }
  36
  37         private String from(final Iterable<String> params) {
  38             final Optional<String> o = Iterables.tryFind(params, predicate);
  39             if (!o.isPresent()) {
  40                 return null;
  41             }
  42
  43             return o.get().substring(skipLength);
  44         }
  45     }
  46
  47     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionCapabilities.class);
  48     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
  49     private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
  50     private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
  51     private static final Splitter AMP_SPLITTER = Splitter.on('&');
  52     private static final Predicate<String> CONTAINS_REVISION = new Predicate<String>() {
  53         @Override
  54         public boolean apply(final String input) {
  55             return input.contains("revision=");
  56         }
  57     };
  58
  59     private final Set<QName> moduleBasedCaps;
  60     private final Set<String> capabilities;
  61
  62     private NetconfSessionCapabilities(final Set<String> capabilities, final Set<QName> moduleBasedCaps) {
  63         this.capabilities = Preconditions.checkNotNull(capabilities);
  64         this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
  65     }
  66
  67     public Set<QName> getModuleBasedCaps() {
  68         return moduleBasedCaps;
  69     }
  70
  71     public boolean containsCapability(final String capability) {
  72         return capabilities.contains(capability);
  73     }
  74
  75     public boolean containsCapability(final QName capability) {
  76         return moduleBasedCaps.contains(capability);
  77     }
  78
  79     @Override
  80     public String toString() {
  81         return Objects.toStringHelper(this)
  82                 .add("capabilities", capabilities)
  83                 .add("rollback", isRollbackSupported())
  84                 .add("monitoring", isMonitoringSupported())
  85                 .toString();
  86     }
  87
  88     public boolean isRollbackSupported() {
  89         return containsCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
  90     }
  91
  92     public boolean isMonitoringSupported() {
  93         return containsCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
  94                 || containsCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
  95     }
  96
  97     public static NetconfSessionCapabilities fromNetconfSession(final NetconfClientSession session) {
  98         return fromStrings(session.getServerCapabilities());
  99     }
 100
 101     public static NetconfSessionCapabilities fromStrings(final Collection<String> capabilities) {
 102         final Set<QName> moduleBasedCaps = new HashSet<>();
 103
 104         for (final String capability : capabilities) {
 105             final int qmark = capability.indexOf('?');
 106             if (qmark == -1) {
 107                 continue;
 108             }
 109
 110             final String namespace = capability.substring(0, qmark);
 111             final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
 112             final String moduleName = MODULE_PARAM.from(queryParams);
 113             if (moduleName == null) {
 114                 continue;
 115             }
 116
 117             String revision = REVISION_PARAM.from(queryParams);
 118             if (revision != null) {
 119                 moduleBasedCaps.add(QName.create(namespace, revision, moduleName));
 120                 continue;
 121             }
 122
 123             /*
 124              * We have seen devices which mis-escape revision, but the revision may not
 125              * even be there. First check if there is a substring that matches revision.
 126              */
 127             if (!Iterables.any(queryParams, CONTAINS_REVISION)) {
 128                 continue;
 129             }
 130
 131             LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
 132             revision = BROKEN_REVISON_PARAM.from(queryParams);
 133             if (revision == null) {
 134                 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
 135             }
 136
 137             // FIXME: do we really want to continue here?
 138             moduleBasedCaps.add(QName.create(namespace, revision, moduleName));
 139         }
 140
 141         return new NetconfSessionCapabilities(ImmutableSet.copyOf(capabilities), ImmutableSet.copyOf(moduleBasedCaps));
 142     }
 143 }