1 package org.opendaylight.controller.sal.connect.netconf.listener;
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 import com.google.common.collect.Sets;
12 import java.util.Collection;
13 import java.util.HashSet;
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;
21 public final class NetconfSessionCapabilities {
23 private static final class ParameterMatcher {
24 private final Predicate<String> predicate;
25 private final int skipLength;
27 ParameterMatcher(final String name) {
28 predicate = new Predicate<String>() {
30 public boolean apply(final String input) {
31 return input.startsWith(name);
35 this.skipLength = name.length();
38 private String from(final Iterable<String> params) {
39 final Optional<String> o = Iterables.tryFind(params, predicate);
44 return o.get().substring(skipLength);
48 private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionCapabilities.class);
49 private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
50 private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
51 private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
52 private static final Splitter AMP_SPLITTER = Splitter.on('&');
53 private static final Predicate<String> CONTAINS_REVISION = new Predicate<String>() {
55 public boolean apply(final String input) {
56 return input.contains("revision=");
60 private final Set<QName> moduleBasedCaps;
61 private final Set<String> nonModuleCaps;
63 private NetconfSessionCapabilities(final Set<String> nonModuleCaps, final Set<QName> moduleBasedCaps) {
64 this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
65 this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
68 public Set<QName> getModuleBasedCaps() {
69 return moduleBasedCaps;
72 public Set<String> getNonModuleCaps() {
76 public boolean containsNonModuleCapability(final String capability) {
77 return nonModuleCaps.contains(capability);
80 public boolean containsModuleCapability(final QName capability) {
81 return moduleBasedCaps.contains(capability);
85 public String toString() {
86 return Objects.toStringHelper(this)
87 .add("capabilities", nonModuleCaps)
88 .add("moduleBasedCapabilities", moduleBasedCaps)
89 .add("rollback", isRollbackSupported())
90 .add("monitoring", isMonitoringSupported())
94 public boolean isRollbackSupported() {
95 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
98 public boolean isCandidateSupported() {
99 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
102 public boolean isMonitoringSupported() {
103 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
104 || containsNonModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
107 public NetconfSessionCapabilities replaceModuleCaps(final NetconfSessionCapabilities netconfSessionModuleCapabilities) {
108 final Set<QName> moduleBasedCaps = Sets.newHashSet(netconfSessionModuleCapabilities.getModuleBasedCaps());
110 // Preserve monitoring module, since it indicates support for ietf-netconf-monitoring
111 if(containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)) {
112 moduleBasedCaps.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING);
114 return new NetconfSessionCapabilities(getNonModuleCaps(), moduleBasedCaps);
117 public static NetconfSessionCapabilities fromNetconfSession(final NetconfClientSession session) {
118 return fromStrings(session.getServerCapabilities());
121 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
122 return QName.cachedReference(QName.create(namespace, revision, moduleName));
125 private static QName cachedQName(final String namespace, final String moduleName) {
126 return QName.cachedReference(QName.create(URI.create(namespace), null, moduleName).withoutRevision());
129 public static NetconfSessionCapabilities fromStrings(final Collection<String> capabilities) {
130 final Set<QName> moduleBasedCaps = new HashSet<>();
131 final Set<String> nonModuleCaps = Sets.newHashSet(capabilities);
133 for (final String capability : capabilities) {
134 final int qmark = capability.indexOf('?');
139 final String namespace = capability.substring(0, qmark);
140 final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
141 final String moduleName = MODULE_PARAM.from(queryParams);
142 if (moduleName == null) {
146 String revision = REVISION_PARAM.from(queryParams);
147 if (revision != null) {
148 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
153 * We have seen devices which mis-escape revision, but the revision may not
154 * even be there. First check if there is a substring that matches revision.
156 if (Iterables.any(queryParams, CONTAINS_REVISION)) {
158 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
159 revision = BROKEN_REVISON_PARAM.from(queryParams);
160 if (revision == null) {
161 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
162 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
164 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
169 // Fallback, no revision provided for module
170 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
173 return new NetconfSessionCapabilities(ImmutableSet.copyOf(nonModuleCaps), ImmutableSet.copyOf(moduleBasedCaps));
177 private static void addModuleQName(final Set<QName> moduleBasedCaps, final Set<String> nonModuleCaps, final String capability, final QName qName) {
178 moduleBasedCaps.add(qName);
179 nonModuleCaps.remove(capability);