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.client.mdsal.api;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.VisibleForTesting;
13 import com.google.common.base.MoreObjects;
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;
20 import java.util.Collection;
21 import java.util.HashMap;
23 import org.eclipse.jdt.annotation.NonNull;
24 import org.eclipse.jdt.annotation.Nullable;
25 import org.opendaylight.netconf.api.CapabilityURN;
26 import org.opendaylight.netconf.client.NetconfClientSession;
27 import org.opendaylight.netconf.client.mdsal.impl.NetconfMessageTransformUtil;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.SessionIdType;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.device.rev231025.connection.oper.available.capabilities.AvailableCapability.CapabilityOrigin;
30 import org.opendaylight.yangtools.yang.common.QName;
31 import org.opendaylight.yangtools.yang.common.XMLNamespace;
32 import org.slf4j.Logger;
33 import org.slf4j.LoggerFactory;
35 public record NetconfSessionPreferences(
36 @NonNull ImmutableMap<String, CapabilityOrigin> nonModuleCaps,
37 @NonNull ImmutableMap<QName, CapabilityOrigin> moduleBasedCaps,
38 @Nullable SessionIdType sessionId) {
39 private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
40 private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
41 private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
42 private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
43 private static final Splitter AMP_SPLITTER = Splitter.on('&');
45 public NetconfSessionPreferences {
46 requireNonNull(nonModuleCaps);
47 requireNonNull(moduleBasedCaps);
50 public static @NonNull NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
51 return fromStrings(session.getServerCapabilities(), CapabilityOrigin.DeviceAdvertised,
56 public static @NonNull NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
57 return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised, null);
60 public static @NonNull NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
61 final CapabilityOrigin capabilityOrigin, final SessionIdType sessionId) {
62 final var moduleBasedCaps = new HashMap<QName, CapabilityOrigin>();
63 final var nonModuleCaps = new HashMap<String, CapabilityOrigin>();
65 for (final String capability : capabilities) {
66 nonModuleCaps.put(capability, capabilityOrigin);
67 final int qmark = capability.indexOf('?');
72 final String namespace = capability.substring(0, qmark);
73 final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
74 final String moduleName = MODULE_PARAM.from(queryParams);
75 if (Strings.isNullOrEmpty(moduleName)) {
79 String revision = REVISION_PARAM.from(queryParams);
80 if (!Strings.isNullOrEmpty(revision)) {
81 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName),
87 * We have seen devices which mis-escape revision, but the revision may not
88 * even be there. First check if there is a substring that matches revision.
90 if (Iterables.any(queryParams, input -> input.contains("revision="))) {
91 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
92 revision = BROKEN_REVISON_PARAM.from(queryParams);
93 if (Strings.isNullOrEmpty(revision)) {
94 LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
95 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
96 cachedQName(namespace, moduleName), capabilityOrigin);
98 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
99 cachedQName(namespace, revision, moduleName), capabilityOrigin);
104 // Fallback, no revision provided for module
105 addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
106 cachedQName(namespace, moduleName), capabilityOrigin);
109 return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps),
113 public @Nullable CapabilityOrigin capabilityOrigin(final QName capability) {
114 return moduleBasedCaps.get(requireNonNull(capability));
117 public @Nullable CapabilityOrigin capabilityOrigin(final String capability) {
118 return nonModuleCaps.get(requireNonNull(capability));
121 // allows partial matches - assuming parameters are in the same order
122 public boolean containsPartialNonModuleCapability(final String capability) {
123 for (var nonModuleCap : nonModuleCaps.keySet()) {
124 if (nonModuleCap.startsWith(capability)) {
125 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
132 public boolean containsNonModuleCapability(final String capability) {
133 return nonModuleCaps.containsKey(capability);
136 public boolean containsModuleCapability(final QName capability) {
137 return moduleBasedCaps.containsKey(capability);
141 public String toString() {
142 return MoreObjects.toStringHelper(this)
143 .add("capabilities", nonModuleCaps)
144 .add("moduleBasedCapabilities", moduleBasedCaps)
145 .add("rollback", isRollbackSupported())
146 .add("monitoring", isMonitoringSupported())
147 .add("candidate", isCandidateSupported())
148 .add("writableRunning", isRunningWritable())
152 public boolean isRollbackSupported() {
153 return containsNonModuleCapability(CapabilityURN.ROLLBACK_ON_ERROR);
156 public boolean isCandidateSupported() {
157 return containsNonModuleCapability(CapabilityURN.CANDIDATE);
160 public boolean isRunningWritable() {
161 return containsNonModuleCapability(CapabilityURN.WRITABLE_RUNNING);
164 public boolean isNotificationsSupported() {
165 return containsPartialNonModuleCapability(CapabilityURN.NOTIFICATION)
166 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
169 public boolean isMonitoringSupported() {
170 return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
171 || containsPartialNonModuleCapability(
172 NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
176 * Merge module-based list of capabilities with current list of module-based capabilities.
178 * @param netconfSessionModuleCapabilities capabilities to merge into this
179 * @return new instance of preferences with merged module-based capabilities
181 public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
182 final var mergedCaps = Maps.<QName, CapabilityOrigin>newHashMapWithExpectedSize(moduleBasedCaps.size()
183 + netconfSessionModuleCapabilities.moduleBasedCaps.size());
184 mergedCaps.putAll(moduleBasedCaps);
185 mergedCaps.putAll(netconfSessionModuleCapabilities.moduleBasedCaps);
186 return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(mergedCaps),
187 netconfSessionModuleCapabilities.sessionId());
191 * Override current list of module-based capabilities.
193 * @param netconfSessionPreferences capabilities to override in this
194 * @return new instance of preferences with replaced module-based capabilities
196 public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
197 return new NetconfSessionPreferences(nonModuleCaps, netconfSessionPreferences.moduleBasedCaps,
198 netconfSessionPreferences.sessionId());
201 public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
202 return new NetconfSessionPreferences(nonModuleCaps, ImmutableMap.copyOf(newModuleBasedCaps), sessionId());
206 * Merge list of non-module based capabilities with current list of non-module based capabilities.
208 * @param netconfSessionNonModuleCapabilities capabilities to merge into this
209 * @return new instance of preferences with merged non-module based capabilities
211 public NetconfSessionPreferences addNonModuleCaps(
212 final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
213 final var mergedCaps = Maps.<String, CapabilityOrigin>newHashMapWithExpectedSize(
214 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.nonModuleCaps.size());
215 mergedCaps.putAll(nonModuleCaps);
216 mergedCaps.putAll(netconfSessionNonModuleCapabilities.nonModuleCaps);
217 return new NetconfSessionPreferences(ImmutableMap.copyOf(mergedCaps), moduleBasedCaps,
218 netconfSessionNonModuleCapabilities.sessionId());
222 * Override current list of non-module based capabilities.
224 * @param netconfSessionPreferences capabilities to override in this
225 * @return new instance of preferences with replaced non-module based capabilities
227 public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
228 return new NetconfSessionPreferences(netconfSessionPreferences.nonModuleCaps, moduleBasedCaps,
229 netconfSessionPreferences.sessionId());
232 private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
233 return QName.create(namespace, revision, moduleName).intern();
236 private static QName cachedQName(final String namespace, final String moduleName) {
237 return QName.create(XMLNamespace.of(namespace), moduleName).withoutRevision().intern();
240 private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps,
241 final Map<String, CapabilityOrigin> nonModuleCaps, final String capability,
242 final QName qualifiedName, final CapabilityOrigin capabilityOrigin) {
243 moduleBasedCaps.put(qualifiedName, capabilityOrigin);
244 nonModuleCaps.remove(capability);
247 private static final class ParameterMatcher {
248 private final Predicate<String> predicate;
249 private final int skipLength;
251 ParameterMatcher(final String name) {
252 predicate = input -> input.startsWith(name);
253 skipLength = name.length();
256 String from(final Iterable<String> params) {
257 final var found = Iterables.tryFind(params, predicate);
258 if (!found.isPresent()) {
261 return found.get().substring(skipLength);