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 NetconfSessionPreferences {
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(NetconfSessionPreferences.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 NetconfSessionPreferences(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())
91 .add("candidate", isCandidateSupported())
92 .add("writableRunning", isRunningWritable())
96 public boolean isRollbackSupported() {
97 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
100 public boolean isCandidateSupported() {
101 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
104 public boolean isRunningWritable() {
105 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
108 public boolean isNotificationsSupported() {
109 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
110 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
113 public boolean isMonitoringSupported() {
114 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
115 || containsNonModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
118 public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
119 final Set<QName> moduleBasedCaps = Sets.newHashSet(netconfSessionModuleCapabilities.getModuleBasedCaps());
121 // Preserve monitoring module, since it indicates support for ietf-netconf-monitoring
122 if(containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)) {
123 moduleBasedCaps.add(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING);
125 return new NetconfSessionPreferences(getNonModuleCaps(), moduleBasedCaps);
128 public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
129 return fromStrings(session.getServerCapabilities());
132 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
133 return QName.cachedReference(QName.create(namespace, revision, moduleName));
136 private static QName cachedQName(final String namespace, final String moduleName) {
137 return QName.cachedReference(QName.create(URI.create(namespace), null, moduleName).withoutRevision());
140 public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
141 final Set<QName> moduleBasedCaps = new HashSet<>();
142 final Set<String> nonModuleCaps = Sets.newHashSet(capabilities);
144 for (final String capability : capabilities) {
145 final int qmark = capability.indexOf('?');
150 final String namespace = capability.substring(0, qmark);
151 final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
152 final String moduleName = MODULE_PARAM.from(queryParams);
153 if (moduleName == null) {
157 String revision = REVISION_PARAM.from(queryParams);
158 if (revision != null) {
159 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
164 * We have seen devices which mis-escape revision, but the revision may not
165 * even be there. First check if there is a substring that matches revision.
167 if (Iterables.any(queryParams, CONTAINS_REVISION)) {
169 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
170 revision = BROKEN_REVISON_PARAM.from(queryParams);
171 if (revision == null) {
172 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
173 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
175 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
180 // Fallback, no revision provided for module
181 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
184 return new NetconfSessionPreferences(ImmutableSet.copyOf(nonModuleCaps), ImmutableSet.copyOf(moduleBasedCaps));
188 private static void addModuleQName(final Set<QName> moduleBasedCaps, final Set<String> nonModuleCaps, final String capability, final QName qName) {
189 moduleBasedCaps.add(qName);
190 nonModuleCaps.remove(capability);
193 private NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
195 public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {