2 * Copyright (c) 2016 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.server.osgi;
10 import static com.google.common.base.Preconditions.checkState;
11 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0;
12 import static org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0;
14 import com.google.common.base.Function;
15 import com.google.common.base.Throwables;
16 import com.google.common.collect.Collections2;
17 import com.google.common.collect.ImmutableSet;
18 import com.google.common.collect.Maps;
19 import java.util.Collection;
20 import java.util.HashMap;
21 import java.util.HashSet;
23 import java.util.Optional;
25 import org.opendaylight.netconf.api.capability.BasicCapability;
26 import org.opendaylight.netconf.api.capability.Capability;
27 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
28 import org.opendaylight.netconf.server.api.monitoring.CapabilityListener;
29 import org.opendaylight.netconf.server.api.monitoring.NetconfMonitoringService;
30 import org.opendaylight.netconf.server.api.operations.NetconfOperationServiceFactory;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.changed.by.server.or.user.ServerBuilder;
44 import org.opendaylight.yangtools.concepts.AbstractRegistration;
45 import org.opendaylight.yangtools.concepts.Registration;
46 import org.opendaylight.yangtools.yang.common.Empty;
48 final class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
49 private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
50 private static final Set<Schema.Location> NETCONF_LOCATIONS = Set.of(NETCONF_LOCATION);
51 private static final BasicCapability CANDIDATE_CAPABILITY =
52 new BasicCapability(URN_IETF_PARAMS_NETCONF_CAPABILITY_CANDIDATE_1_0);
53 private static final BasicCapability URL_CAPABILITY =
54 new BasicCapability(URN_IETF_PARAMS_NETCONF_CAPABILITY_URL_1_0);
55 private static final Function<Capability, Uri> CAPABILITY_TO_URI = input -> new Uri(input.getCapabilityUri());
57 private final NetconfOperationServiceFactory netconfOperationProvider;
58 private final Map<Uri, Capability> capabilities = new HashMap<>();
59 private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = new HashMap<>();
61 private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = new HashSet<>();
62 private volatile BaseNotificationPublisherRegistration notificationPublisher;
64 NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
65 this.netconfOperationProvider = netconfOperationProvider;
66 netconfOperationProvider.registerCapabilityListener(this);
69 @SuppressWarnings("checkstyle:IllegalCatch")
70 synchronized Schemas getSchemas() {
72 return transformSchemas(netconfOperationProvider.getCapabilities());
73 } catch (final Exception e) {
74 Throwables.throwIfUnchecked(e);
75 throw new IllegalStateException("Exception while closing", e);
79 synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
80 final Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
81 checkState(revisionMapRequest != null,
82 "Capability for module %s not present, available modules : %s",
83 moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
85 final String revToLookup = revision.orElse("");
86 final String schema = revisionMapRequest.get(revToLookup);
92 // We can recover only if the revision was not specified
93 checkState(revision.isEmpty(),
94 "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
95 revToLookup, revisionMapRequest.keySet());
97 checkState(revisionMapRequest.size() == 1,
98 "Expected 1 capability for module %s, available revisions : %s", moduleName,
99 revisionMapRequest.keySet());
100 // Only one revision is present, so return it
101 return revisionMapRequest.values().iterator().next();
104 private void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
105 for (final Capability cap : added) {
106 if (isValidModuleCapability(cap)) {
107 mappedModulesToRevisionToSchema.computeIfAbsent(cap.getModuleName().orElseThrow(), k -> new HashMap<>())
108 .put(cap.getRevision().orElse(""), cap.getCapabilitySchema().orElseThrow());
111 for (final Capability cap : removed) {
112 if (isValidModuleCapability(cap)) {
113 final Map<String, String> revisionMap =
114 mappedModulesToRevisionToSchema.get(cap.getModuleName().orElseThrow());
115 if (revisionMap != null) {
116 revisionMap.remove(cap.getRevision().orElseThrow());
117 if (revisionMap.isEmpty()) {
118 mappedModulesToRevisionToSchema.remove(cap.getModuleName().orElseThrow());
125 private static boolean isValidModuleCapability(final Capability cap) {
126 return cap.getModuleName().isPresent() && cap.getCapabilitySchema().isPresent();
129 synchronized Capabilities getCapabilities() {
130 return new CapabilitiesBuilder().setCapability(Set.copyOf(capabilities.keySet())).build();
133 synchronized Registration registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
134 listeners.add(listener);
135 listener.onCapabilitiesChanged(getCapabilities());
136 listener.onSchemasChanged(getSchemas());
137 return new AbstractRegistration() {
139 protected void removeRegistration() {
140 synchronized (NetconfCapabilityMonitoringService.this) {
141 listeners.remove(listener);
147 private static Schemas transformSchemas(final Set<Capability> caps) {
148 final Map<SchemaKey, Schema> schemas = Maps.newHashMapWithExpectedSize(caps.size());
149 for (final Capability cap : caps) {
150 if (isValidModuleCapability(cap)) {
151 final SchemaKey key = new SchemaKey(Yang.VALUE, cap.getModuleName().orElseThrow(),
152 cap.getRevision().orElse(""));
153 schemas.put(key, new SchemaBuilder()
155 .setNamespace(new Uri(cap.getModuleNamespace().orElseThrow()))
156 .setLocation(transformLocations(cap.getLocation()))
161 return new SchemasBuilder().setSchema(schemas).build();
164 private static Set<Schema.Location> transformLocations(final Collection<String> locations) {
165 if (locations.isEmpty()) {
166 return NETCONF_LOCATIONS;
169 final var b = ImmutableSet.<Schema.Location>builder();
170 b.add(NETCONF_LOCATION);
172 for (final String location : locations) {
173 b.add(new Schema.Location(new Uri(location)));
179 private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
180 Set<Capability> capabilities = new HashSet<>(caps);
181 capabilities.add(CANDIDATE_CAPABILITY);
182 capabilities.add(URL_CAPABILITY);
183 // TODO rollback on error not supported EditConfigXmlParser:100
184 // [RFC6241] 8.5. Rollback-on-Error Capability
185 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
190 public synchronized void close() {
192 capabilities.clear();
196 public synchronized void onCapabilitiesChanged(final Set<Capability> added, final Set<Capability> removed) {
197 onCapabilitiesAdded(added);
198 onCapabilitiesRemoved(removed);
199 updateCapabilityToSchemaMap(added, removed);
200 notifyCapabilityChanged(getCapabilities());
202 // publish notification to notification collector about changed capabilities
203 if (notificationPublisher != null) {
204 notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
208 private void notifyCapabilityChanged(final Capabilities newCapabilities) {
209 for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
210 listener.onCapabilitiesChanged(newCapabilities);
211 listener.onSchemasChanged(getSchemas());
216 private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
217 return new NetconfCapabilityChangeBuilder()
218 .setChangedBy(new ChangedByBuilder()
219 .setServerOrUser(new ServerBuilder().setServer(Empty.value()).build())
221 .setDeletedCapability(Set.copyOf(Collections2.transform(removed, CAPABILITY_TO_URI)))
222 .setAddedCapability(Set.copyOf(Collections2.transform(added, CAPABILITY_TO_URI)))
223 // TODO modified should be computed ... but why ?
224 .setModifiedCapability(Set.of())
229 private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
230 capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
233 private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
234 for (final Capability addedCap : removedCaps) {
235 capabilities.remove(new Uri(addedCap.getCapabilityUri()));
239 void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
240 this.notificationPublisher = notificationPublisher;