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.ImmutableMap;
18 import com.google.common.collect.Iterables;
19 import com.google.common.collect.Maps;
21 import java.util.Collection;
22 import java.util.HashMap;
23 import java.util.Iterator;
26 import org.opendaylight.netconf.client.NetconfClientSession;
27 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
29 import org.opendaylight.yangtools.yang.common.QName;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
33 public final class NetconfSessionPreferences {
35 private static final class ParameterMatcher {
36 private final Predicate<String> predicate;
37 private final int skipLength;
39 ParameterMatcher(final String name) {
40 predicate = new Predicate<String>() {
42 public boolean apply(final String input) {
43 return input.startsWith(name);
47 this.skipLength = name.length();
50 private String from(final Iterable<String> params) {
51 final Optional<String> o = Iterables.tryFind(params, predicate);
56 return o.get().substring(skipLength);
60 private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
61 private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
62 private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
63 private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
64 private static final Splitter AMP_SPLITTER = Splitter.on('&');
65 private static final Predicate<String> CONTAINS_REVISION = new Predicate<String>() {
67 public boolean apply(final String input) {
68 return input.contains("revision=");
72 private final Map<QName, CapabilityOrigin> moduleBasedCaps;
73 private final Map<String, CapabilityOrigin> nonModuleCaps;
75 NetconfSessionPreferences(final Map<String, CapabilityOrigin> nonModuleCaps, final Map<QName, CapabilityOrigin> moduleBasedCaps) {
76 this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
77 this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
80 public Set<QName> getModuleBasedCaps() {
81 return moduleBasedCaps.keySet();
84 public Map<QName, CapabilityOrigin> getModuleBasedCapsOrigin() {
85 return moduleBasedCaps;
88 public Set<String> getNonModuleCaps() {
89 return nonModuleCaps.keySet();
92 public Map<String, CapabilityOrigin> getNonModuleBasedCapsOrigin() {
96 // allows partial matches - assuming parameters are in the same order
97 public boolean containsPartialNonModuleCapability(final String capability) {
98 final Iterator<String> iterator = getNonModuleCaps().iterator();
99 while(iterator.hasNext()) {
100 if (iterator.next().startsWith(capability)) {
101 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
108 public boolean containsNonModuleCapability(final String capability) {
109 return nonModuleCaps.containsKey(capability);
112 public boolean containsModuleCapability(final QName capability) {
113 return moduleBasedCaps.containsKey(capability);
117 public String toString() {
118 return MoreObjects.toStringHelper(this)
119 .add("capabilities", nonModuleCaps)
120 .add("moduleBasedCapabilities", moduleBasedCaps)
121 .add("rollback", isRollbackSupported())
122 .add("monitoring", isMonitoringSupported())
123 .add("candidate", isCandidateSupported())
124 .add("writableRunning", isRunningWritable())
128 public boolean isRollbackSupported() {
129 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
132 public boolean isCandidateSupported() {
133 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
136 public boolean isRunningWritable() {
137 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
140 public boolean isNotificationsSupported() {
141 return containsPartialNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
142 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
145 public boolean isMonitoringSupported() {
146 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
147 || containsPartialNonModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
151 * Merge module-based list of capabilities with current list of module-based capabilities
153 * @param netconfSessionModuleCapabilities capabilities to merge into this
155 * @return new instance of preferences with merged module-based capabilities
157 public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
158 final Map<QName, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(moduleBasedCaps.size() + netconfSessionModuleCapabilities.getModuleBasedCaps().size());
159 mergedCaps.putAll(moduleBasedCaps);
160 mergedCaps.putAll(netconfSessionModuleCapabilities.getModuleBasedCapsOrigin());
161 return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), mergedCaps);
165 * Override current list of module-based capabilities
167 * @param netconfSessionPreferences capabilities to override in this
169 * @return new instance of preferences with replaced module-based capabilities
171 public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
172 return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), netconfSessionPreferences.getModuleBasedCapsOrigin());
175 public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
176 return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), newModuleBasedCaps);
181 * Merge list of non-module based capabilities with current list of non-module based capabilities
183 * @param netconfSessionNonModuleCapabilities capabilities to merge into this
185 * @return new instance of preferences with merged non-module based capabilities
187 public NetconfSessionPreferences addNonModuleCaps(
188 final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
189 final Map<String, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(
190 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.getNonModuleCaps().size());
191 mergedCaps.putAll(getNonModuleBasedCapsOrigin());
192 mergedCaps.putAll(netconfSessionNonModuleCapabilities.getNonModuleBasedCapsOrigin());
193 return new NetconfSessionPreferences(mergedCaps, getModuleBasedCapsOrigin());
197 * Override current list of non-module based capabilities
199 * @param netconfSessionPreferences capabilities to override in this
201 * @return new instance of preferences with replaced non-module based capabilities
203 public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
204 return new NetconfSessionPreferences(netconfSessionPreferences.getNonModuleBasedCapsOrigin(), getModuleBasedCapsOrigin());
207 public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
208 return fromStrings(session.getServerCapabilities());
211 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
212 return QName.create(namespace, revision, moduleName).intern();
215 private static QName cachedQName(final String namespace, final String moduleName) {
216 return QName.create(URI.create(namespace), null, moduleName).withoutRevision().intern();
219 public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
220 // we do not know origin of capabilities from only Strings, so we set it to default value
221 return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised);
224 public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities, final CapabilityOrigin capabilityOrigin) {
225 final Map<QName, CapabilityOrigin> moduleBasedCaps = new HashMap<>();
226 final Map<String, CapabilityOrigin> nonModuleCaps = new HashMap<>();
228 for (final String capability : capabilities) {
229 nonModuleCaps.put(capability, capabilityOrigin);
230 final int qmark = capability.indexOf('?');
235 final String namespace = capability.substring(0, qmark);
236 final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
237 final String moduleName = MODULE_PARAM.from(queryParams);
238 if (Strings.isNullOrEmpty(moduleName)) {
242 String revision = REVISION_PARAM.from(queryParams);
243 if (!Strings.isNullOrEmpty(revision)) {
244 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName), capabilityOrigin);
249 * We have seen devices which mis-escape revision, but the revision may not
250 * even be there. First check if there is a substring that matches revision.
252 if (Iterables.any(queryParams, CONTAINS_REVISION)) {
254 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
255 revision = BROKEN_REVISON_PARAM.from(queryParams);
256 if (Strings.isNullOrEmpty(revision)) {
257 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
258 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName), capabilityOrigin);
260 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName), capabilityOrigin);
265 // Fallback, no revision provided for module
266 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, moduleName), capabilityOrigin);
269 return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps));
272 private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps, final Map<String, CapabilityOrigin> nonModuleCaps, final String capability, final QName qName, final CapabilityOrigin capabilityOrigin) {
273 moduleBasedCaps.put(qName, capabilityOrigin);
274 nonModuleCaps.remove(capability);
277 private final NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
279 public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {