d5383afda7921ce54cc5ec6913f85570b5ba0531
[netconf.git] / netconf / sal-netconf-connector / src / main / java / org / opendaylight / netconf / sal / connect / netconf / listener / NetconfSessionPreferences.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8
9 package org.opendaylight.netconf.sal.connect.netconf.listener;
10
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;
20 import java.net.URI;
21 import java.util.Collection;
22 import java.util.HashMap;
23 import java.util.Iterator;
24 import java.util.Map;
25 import java.util.Set;
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;
32
33 public final class NetconfSessionPreferences {
34
35     private static final class ParameterMatcher {
36         private final Predicate<String> predicate;
37         private final int skipLength;
38
39         ParameterMatcher(final String name) {
40             predicate = input -> input.startsWith(name);
41
42             this.skipLength = name.length();
43         }
44
45         private String from(final Iterable<String> params) {
46             final Optional<String> o = Iterables.tryFind(params, predicate);
47             if (!o.isPresent()) {
48                 return null;
49             }
50
51             return o.get().substring(skipLength);
52         }
53     }
54
55     private static final Logger LOG = LoggerFactory.getLogger(NetconfSessionPreferences.class);
56     private static final ParameterMatcher MODULE_PARAM = new ParameterMatcher("module=");
57     private static final ParameterMatcher REVISION_PARAM = new ParameterMatcher("revision=");
58     private static final ParameterMatcher BROKEN_REVISON_PARAM = new ParameterMatcher("amp;revision=");
59     private static final Splitter AMP_SPLITTER = Splitter.on('&');
60     private static final Predicate<String> CONTAINS_REVISION = input -> input.contains("revision=");
61
62     private final Map<QName, CapabilityOrigin> moduleBasedCaps;
63     private final Map<String, CapabilityOrigin> nonModuleCaps;
64
65     NetconfSessionPreferences(final Map<String, CapabilityOrigin> nonModuleCaps,
66                               final Map<QName, CapabilityOrigin> moduleBasedCaps) {
67         this.nonModuleCaps = Preconditions.checkNotNull(nonModuleCaps);
68         this.moduleBasedCaps = Preconditions.checkNotNull(moduleBasedCaps);
69     }
70
71     public Set<QName> getModuleBasedCaps() {
72         return moduleBasedCaps.keySet();
73     }
74
75     public Map<QName, CapabilityOrigin> getModuleBasedCapsOrigin() {
76         return moduleBasedCaps;
77     }
78
79     public Set<String> getNonModuleCaps() {
80         return nonModuleCaps.keySet();
81     }
82
83     public Map<String, CapabilityOrigin> getNonModuleBasedCapsOrigin() {
84         return nonModuleCaps;
85     }
86
87     // allows partial matches - assuming parameters are in the same order
88     public boolean containsPartialNonModuleCapability(final String capability) {
89         final Iterator<String> iterator = getNonModuleCaps().iterator();
90         while (iterator.hasNext()) {
91             if (iterator.next().startsWith(capability)) {
92                 LOG.trace("capability {} partially matches {}", capability, nonModuleCaps);
93                 return true;
94             }
95         }
96         return false;
97     }
98
99     public boolean containsNonModuleCapability(final String capability) {
100         return nonModuleCaps.containsKey(capability);
101     }
102
103     public boolean containsModuleCapability(final QName capability) {
104         return moduleBasedCaps.containsKey(capability);
105     }
106
107     @Override
108     public String toString() {
109         return MoreObjects.toStringHelper(this)
110                 .add("capabilities", nonModuleCaps)
111                 .add("moduleBasedCapabilities", moduleBasedCaps)
112                 .add("rollback", isRollbackSupported())
113                 .add("monitoring", isMonitoringSupported())
114                 .add("candidate", isCandidateSupported())
115                 .add("writableRunning", isRunningWritable())
116                 .toString();
117     }
118
119     public boolean isRollbackSupported() {
120         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_ROLLBACK_ON_ERROR_URI.toString());
121     }
122
123     public boolean isCandidateSupported() {
124         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_CANDIDATE_URI.toString());
125     }
126
127     public boolean isRunningWritable() {
128         return containsNonModuleCapability(NetconfMessageTransformUtil.NETCONF_RUNNING_WRITABLE_URI.toString());
129     }
130
131     public boolean isNotificationsSupported() {
132         return containsPartialNonModuleCapability(NetconfMessageTransformUtil.NETCONF_NOTIFICATONS_URI.toString())
133                 || containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS);
134     }
135
136     public boolean isMonitoringSupported() {
137         return containsModuleCapability(NetconfMessageTransformUtil.IETF_NETCONF_MONITORING)
138                 || containsPartialNonModuleCapability(
139                         NetconfMessageTransformUtil.IETF_NETCONF_MONITORING.getNamespace().toString());
140     }
141
142     /**
143      * Merge module-based list of capabilities with current list of module-based capabilities.
144      *
145      * @param netconfSessionModuleCapabilities capabilities to merge into this
146      *
147      * @return new instance of preferences with merged module-based capabilities
148      */
149     public NetconfSessionPreferences addModuleCaps(final NetconfSessionPreferences netconfSessionModuleCapabilities) {
150         final Map<QName, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(moduleBasedCaps.size()
151                 + netconfSessionModuleCapabilities.getModuleBasedCaps().size());
152         mergedCaps.putAll(moduleBasedCaps);
153         mergedCaps.putAll(netconfSessionModuleCapabilities.getModuleBasedCapsOrigin());
154         return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), mergedCaps);
155     }
156
157     /**
158      * Override current list of module-based capabilities.
159      *
160      * @param netconfSessionPreferences capabilities to override in this
161      *
162      * @return new instance of preferences with replaced module-based capabilities
163      */
164     public NetconfSessionPreferences replaceModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
165         return new NetconfSessionPreferences(
166                 getNonModuleBasedCapsOrigin(), netconfSessionPreferences.getModuleBasedCapsOrigin());
167     }
168
169     public NetconfSessionPreferences replaceModuleCaps(final Map<QName, CapabilityOrigin> newModuleBasedCaps) {
170         return new NetconfSessionPreferences(getNonModuleBasedCapsOrigin(), newModuleBasedCaps);
171     }
172
173
174     /**
175      * Merge list of non-module based capabilities with current list of non-module based capabilities.
176      *
177      * @param netconfSessionNonModuleCapabilities capabilities to merge into this
178      *
179      * @return new instance of preferences with merged non-module based capabilities
180      */
181     public NetconfSessionPreferences addNonModuleCaps(
182             final NetconfSessionPreferences netconfSessionNonModuleCapabilities) {
183         final Map<String, CapabilityOrigin> mergedCaps = Maps.newHashMapWithExpectedSize(
184                 nonModuleCaps.size() + netconfSessionNonModuleCapabilities.getNonModuleCaps().size());
185         mergedCaps.putAll(getNonModuleBasedCapsOrigin());
186         mergedCaps.putAll(netconfSessionNonModuleCapabilities.getNonModuleBasedCapsOrigin());
187         return new NetconfSessionPreferences(mergedCaps, getModuleBasedCapsOrigin());
188     }
189
190     /**
191      * Override current list of non-module based capabilities.
192      *
193      * @param netconfSessionPreferences capabilities to override in this
194      *
195      * @return new instance of preferences with replaced non-module based capabilities
196      */
197     public NetconfSessionPreferences replaceNonModuleCaps(final NetconfSessionPreferences netconfSessionPreferences) {
198         return new NetconfSessionPreferences(
199                 netconfSessionPreferences.getNonModuleBasedCapsOrigin(), getModuleBasedCapsOrigin());
200     }
201
202     public static NetconfSessionPreferences fromNetconfSession(final NetconfClientSession session) {
203         return fromStrings(session.getServerCapabilities());
204     }
205
206     private static QName cachedQName(final String namespace, final String revision, final String moduleName) {
207         return QName.create(namespace, revision, moduleName).intern();
208     }
209
210     private static QName cachedQName(final String namespace, final String moduleName) {
211         return QName.create(URI.create(namespace), moduleName).withoutRevision().intern();
212     }
213
214     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities) {
215         // we do not know origin of capabilities from only Strings, so we set it to default value
216         return fromStrings(capabilities, CapabilityOrigin.DeviceAdvertised);
217     }
218
219     public static NetconfSessionPreferences fromStrings(final Collection<String> capabilities,
220                                                         final CapabilityOrigin capabilityOrigin) {
221         final Map<QName, CapabilityOrigin> moduleBasedCaps = new HashMap<>();
222         final Map<String, CapabilityOrigin> nonModuleCaps = new HashMap<>();
223
224         for (final String capability : capabilities) {
225             nonModuleCaps.put(capability, capabilityOrigin);
226             final int qmark = capability.indexOf('?');
227             if (qmark == -1) {
228                 continue;
229             }
230
231             final String namespace = capability.substring(0, qmark);
232             final Iterable<String> queryParams = AMP_SPLITTER.split(capability.substring(qmark + 1));
233             final String moduleName = MODULE_PARAM.from(queryParams);
234             if (Strings.isNullOrEmpty(moduleName)) {
235                 continue;
236             }
237
238             String revision = REVISION_PARAM.from(queryParams);
239             if (!Strings.isNullOrEmpty(revision)) {
240                 addModuleQName(moduleBasedCaps, nonModuleCaps, capability, cachedQName(namespace, revision, moduleName),
241                         capabilityOrigin);
242                 continue;
243             }
244
245             /*
246              * We have seen devices which mis-escape revision, but the revision may not
247              * even be there. First check if there is a substring that matches revision.
248              */
249             if (Iterables.any(queryParams, CONTAINS_REVISION)) {
250
251                 LOG.debug("Netconf device was not reporting revision correctly, trying to get amp;revision=");
252                 revision = BROKEN_REVISON_PARAM.from(queryParams);
253                 if (Strings.isNullOrEmpty(revision)) {
254                     LOG.warn("Netconf device returned revision incorrectly escaped for {}, ignoring it", capability);
255                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
256                             cachedQName(namespace, moduleName), capabilityOrigin);
257                 } else {
258                     addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
259                             cachedQName(namespace, revision, moduleName), capabilityOrigin);
260                 }
261                 continue;
262             }
263
264             // Fallback, no revision provided for module
265             addModuleQName(moduleBasedCaps, nonModuleCaps, capability,
266                     cachedQName(namespace, moduleName), capabilityOrigin);
267         }
268
269         return new NetconfSessionPreferences(ImmutableMap.copyOf(nonModuleCaps), ImmutableMap.copyOf(moduleBasedCaps));
270     }
271
272     private static void addModuleQName(final Map<QName, CapabilityOrigin> moduleBasedCaps,
273                                        final Map<String, CapabilityOrigin> nonModuleCaps, final String capability,
274                                        final QName qualifiedName, final CapabilityOrigin capabilityOrigin) {
275         moduleBasedCaps.put(qualifiedName, capabilityOrigin);
276         nonModuleCaps.remove(capability);
277     }
278
279     private final NetconfDeviceCapabilities capabilities = new NetconfDeviceCapabilities();
280
281     public NetconfDeviceCapabilities getNetconfDeviceCapabilities() {
282         return capabilities;
283     }
284
285
286 }