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
8 package org.opendaylight.netconf.sal.connect.netconf.listener;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.base.MoreObjects;
13 import com.google.common.base.Predicate;
14 import com.google.common.base.Splitter;
15 import com.google.common.base.Strings;
16 import com.google.common.collect.ImmutableMap;
17 import com.google.common.collect.Iterables;
18 import com.google.common.collect.Maps;
19 import java.util.Collection;
20 import java.util.HashMap;
22 import org.eclipse.jdt.annotation.NonNull;
23 import org.eclipse.jdt.annotation.Nullable;
24 import org.opendaylight.netconf.client.NetconfClientSession;
25 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability.CapabilityOrigin;
27 import org.opendaylight.yangtools.yang.common.QName;
28 import org.opendaylight.yangtools.yang.common.XMLNamespace;
29 import org.slf4j.Logger;
30 import org.slf4j.LoggerFactory;
32 // FIXME: propagate to API with immutable semantics
33 public record NetconfSessionPreferences(
34 @NonNull ImmutableMap<String, CapabilityOrigin> nonModuleCaps,
35 @NonNull ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps) {
36 private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
37 private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
38 private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
39 private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
40 private static final Splitter AMP_SPLITTER = Splitter.on('&');
42 public NetconfSessionPreferences {
43 requireNonNull(nonModuleCaps);
44 requireNonNull(moduleBasedCaps);
47 public static @NonNull NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
48 return fromStrings(session.getServerCapabilities());
51 public static @NonNull NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
52 // we do not know origin of capabilities from only Strings, so we set it to default value
53 return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised);
56 public static @NonNull NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
57 final CapabilityOrigin capabilityOrigin) {
58 final var moduleBasedCaps = new HashMap<QName, CapabilityOrigin>();
59 final var nonModuleCaps = new HashMap<String, CapabilityOrigin>();
61 for (final String capability : capabilities) {
62 nonModuleCaps.put(capability, capabilityOrigin);
63 final int qmark = capability.indexOf('?');
68 final String namespace = capability.substring(0, qmark);
69 final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
70 final String moduleName = MODULE_PARAM.from(queryParams);
71 if (Strings.isNullOrEmpty(moduleName)) {
75 String revision = REVISION_PARAM.from(queryParams);
76 if (!Strings.isNullOrEmpty(revision)) {
77 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName),
83 * We have seen devices which mis-escape revision, but the revision may not
84 * even be there. First check if there is a substring that matches revision.
86 if (Iterables.any(queryParams, input -> input.contains("revision="))) {
87 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
88 revision = BROKEN_REVISON_PARAM.from(queryParams);
89 if (Strings.isNullOrEmpty(revision)) {
90 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
91 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
92 cachedQName(namespace, moduleName), capabilityOrigin);
94 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
95 cachedQName(namespace, revision, moduleName), capabilityOrigin);
100 // Fallback, no revision provided for module
101 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
102 cachedQName(namespace, moduleName), capabilityOrigin);
105 return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps));
108 public @Nullable CapabilityOrigin capabilityOrigin(final QName capability) {
109 return moduleBasedCaps.get(requireNonNull(capability));
112 public @Nullable CapabilityOrigin capabilityOrigin(final String capability) {
113 return nonModuleCaps.get(requireNonNull(capability));
116 // allows partial matches - assuming parameters are in the same order
117 public boolean containsPartialNonModuleCapability(final String capability) {
118 for (var nonModuleCap : nonModuleCaps.keySet()) {
119 if (nonModuleCap.startsWith(capability)) {
120 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
127 public boolean containsNonModuleCapability(final String capability) {
128 return nonModuleCaps.containsKey(capability);
131 public boolean containsModuleCapability(final QName capability) {
132 return moduleBasedCaps.containsKey(capability);
136 public String toString() {
137 return MoreObjects.toStringHelper(this)
138 .add("capabilities", nonModuleCaps)
139 .add("moduleBasedCapabilities", moduleBasedCaps)
140 .add("rollback", isRollbackSupported())
141 .add("monitoring", isMonitoringSupported())
142 .add("candidate", isCandidateSupported())
143 .add("writableRunning", isRunningWritable())
147 public boolean isRollbackSupported() {
148 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
151 public boolean isCandidateSupported() {
152 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
155 public boolean isRunningWritable() {
156 return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
159 public boolean isNotificationsSupported() {
160 return containsPartialNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
161 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
164 public boolean isMonitoringSupported() {
165 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
166 || containsPartialNonModuleCapability(
167 NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
171 * Merge module-based list of capabilities with current list of module-based capabilities.
173 * @param netconfSessionModuleCapabilities capabilities to merge into this
174 * @return new instance of preferences with merged module-based capabilities
176 public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
177 final var mergedCaps = Maps.<QName, CapabilityOrigin>newHashMapWithExpectedSize(moduleBasedCaps.size()
178 + netconfSessionModuleCapabilities.moduleBasedCaps.size());
179 mergedCaps.putAll(moduleBasedCaps);
180 mergedCaps.putAll(netconfSessionModuleCapabilities.moduleBasedCaps);
181 return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(mergedCaps));
185 * Override current list of module-based capabilities.
187 * @param netconfSessionPreferences capabilities to override in this
188 * @return new instance of preferences with replaced module-based capabilities
190 public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
191 return new NetconfSessionPreferences(nonModuleCaps, netconfSessionPreferences.moduleBasedCaps);
194 public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
195 return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(newModuleBasedCaps));
199 * Merge list of non-module based capabilities with current list of non-module based capabilities.
201 * @param netconfSessionNonModuleCapabilities capabilities to merge into this
202 * @return new instance of preferences with merged non-module based capabilities
204 public NetconfSessionPreferences addNonModuleCaps(
205 final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
206 final var mergedCaps = Maps.<String, CapabilityOrigin>newHashMapWithExpectedSize(
207 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.nonModuleCaps.size());
208 mergedCaps.putAll(nonModuleCaps);
209 mergedCaps.putAll(netconfSessionNonModuleCapabilities.nonModuleCaps);
210 return new NetconfSessionPreferences(ImmutableMap.copyOf(mergedCaps), moduleBasedCaps);
214 * Override current list of non-module based capabilities.
216 * @param netconfSessionPreferences capabilities to override in this
217 * @return new instance of preferences with replaced non-module based capabilities
219 public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
220 return new NetconfSessionPreferences(netconfSessionPreferences.nonModuleCaps, moduleBasedCaps);
223 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
224 return QName.create(namespace, revision, moduleName).intern();
227 private static QName cachedQName(final String namespace, final String moduleName) {
228 return QName.create(XMLNamespace.of(namespace), moduleName).withoutRevision().intern();
231 private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps,
232 final Map<String, CapabilityOrigin> nonModuleCaps, final String capability,
233 final QName qualifiedName, final CapabilityOrigin capabilityOrigin) {
234 moduleBasedCaps.put(qualifiedName, capabilityOrigin);
235 nonModuleCaps.remove(capability);
238 private static final class ParameterMatcher {
239 private final Predicate<String> predicate;
240 private final int skipLength;
242 ParameterMatcher(final String name) {
243 predicate = input -> input.startsWith(name);
244 skipLength = name.length();
247 String from(final Iterable<String> params) {
248 final var found = Iterables.tryFind(params, predicate);
249 if (!found.isPresent()) {
252 return found.get().substring(skipLength);