2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.netconf.sal.connect.netconf.listener;
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;
21 import java.util.Collection;
22 import java.util.HashSet;
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;
30 public final class NetconfSessionPreferences {
32 private static final class ParameterMatcher {
33 private final Predicate<String> predicate;
34 private final int skipLength;
36 ParameterMatcher(final String name) {
37 predicate = new Predicate<String>() {
39 public boolean apply(final String input) {
40 return input.startsWith(name);
44 this.skipLength = name.length();
47 private String from(final Iterable<String> params) {
48 final Optional<String> o = Iterables.tryFind(params, predicate);
53 return o.get().substring(skipLength);
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>() {
64 public boolean apply(final String input) {
65 return input.contains("revision=");
69 private final Set<QName> moduleBasedCaps;
70 private final Set<String> nonModuleCaps;
72 NetconfSessionPreferences(final Set<String> nonModuleCaps, final Set<QName> moduleBasedCaps) {
73 this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
74 this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
77 public Set<QName> getModuleBasedCaps() {
78 return moduleBasedCaps;
81 public Set<String> getNonModuleCaps() {
85 public boolean containsNonModuleCapability(final String capability) {
86 return nonModuleCaps.contains(capability);
89 public boolean containsModuleCapability(final QName capability) {
90 return moduleBasedCaps.contains(capability);
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())
105 public boolean isRollbackSupported() {
106 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
109 public boolean isCandidateSupported() {
110 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
113 public boolean isRunningWritable() {
114 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
117 public boolean isNotificationsSupported() {
118 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
119 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
122 public boolean isMonitoringSupported() {
123 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
124 || containsNonModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
128 * Merge module-based list of capabilities with current list of module-based capabilities
130 * @param netconfSessionModuleCapabilities capabilities to merge into this
132 * @return new instance of preferences with merged module-based capabilities
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);
142 * Override current list of module-based capabilities
144 * @param netconfSessionPreferences capabilities to override in this
146 * @return new instance of preferences with replaced module-based capabilities
148 public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
149 return new NetconfSessionPreferences(getNonModuleCaps(), netconfSessionPreferences.getModuleBasedCaps());
152 public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
153 return fromStrings(session.getServerCapabilities());
156 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
157 return QName.create(namespace, revision, moduleName).intern();
160 private static QName cachedQName(final String namespace, final String moduleName) {
161 return QName.create(URI.create(namespace), null, moduleName).withoutRevision().intern();
164 public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
165 final Set<QName> moduleBasedCaps = new HashSet<>();
166 final Set<String> nonModuleCaps = Sets.newHashSet(capabilities);
168 for (final String capability : capabilities) {
169 final int qmark = capability.indexOf('?');
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)) {
181 String revision = REVISION_PARAM.from(queryParams);
182 if (!Strings.isNullOrEmpty(revision)) {
183 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
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.
191 if (Iterables.any(queryParams, CONTAINS_REVISION)) {
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));
199 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName));
204 // Fallback, no revision provided for module
205 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName));
208 return new NetconfSessionPreferences(ImmutableSet.copyOf(nonModuleCaps), ImmutableSet.copyOf(moduleBasedCaps));
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);
217 private NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
219 public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {