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.impl.osgi;
10 import com.google.common.base.Function;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.Collections2;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableList.Builder;
16 import com.google.common.collect.Lists;
17 import com.google.common.collect.Maps;
18 import com.google.common.collect.Sets;
19 import java.util.ArrayList;
20 import java.util.Collection;
21 import java.util.Collections;
22 import java.util.HashSet;
23 import java.util.List;
26 import org.opendaylight.netconf.api.capability.BasicCapability;
27 import org.opendaylight.netconf.api.capability.Capability;
28 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
29 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
30 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
31 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
44 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;
46 class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
48 private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
49 private static final List<Schema.Location> NETCONF_LOCATIONS = ImmutableList.of(NETCONF_LOCATION);
50 private static final BasicCapability CANDIDATE_CAPABILITY =
51 new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0");
52 private static final Function<Capability, Uri> CAPABILITY_TO_URI = input -> new Uri(input.getCapabilityUri());
54 private final NetconfOperationServiceFactory netconfOperationProvider;
55 private final Map<Uri, Capability> capabilities = Maps.newHashMap();
56 private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
59 private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = Sets.newHashSet();
60 private volatile BaseNotificationPublisherRegistration notificationPublisher;
62 NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
63 this.netconfOperationProvider = netconfOperationProvider;
64 netconfOperationProvider.registerCapabilityListener(this);
67 @SuppressWarnings("checkstyle:IllegalCatch")
68 synchronized Schemas getSchemas() {
70 return transformSchemas(netconfOperationProvider.getCapabilities());
71 } catch (final RuntimeException e) {
73 } catch (final Exception e) {
74 throw new IllegalStateException("Exception while closing", e);
78 synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
80 Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
81 Preconditions.checkState(revisionMapRequest != null,
82 "Capability for module %s not present, available modules : %s",
83 moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
85 if (revision.isPresent()) {
86 String schema = revisionMapRequest.get(revision.get());
88 Preconditions.checkState(schema != null,
89 "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
90 revision.get(), revisionMapRequest.keySet());
95 Preconditions.checkState(revisionMapRequest.size() == 1,
96 "Expected 1 capability for module %s, available revisions : %s", moduleName,
97 revisionMapRequest.keySet());
98 //Only one revision is present, so return it
99 return revisionMapRequest.values().iterator().next();
102 private void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
103 for (final Capability cap : added) {
104 if (!isValidModuleCapability(cap)) {
108 final String currentModuleName = cap.getModuleName().get();
109 Map<String, String> revisionMap =
110 mappedModulesToRevisionToSchema.computeIfAbsent(currentModuleName, k -> Maps.newHashMap());
112 final String currentRevision = cap.getRevision().get();
113 revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
115 for (final Capability cap : removed) {
116 if (!isValidModuleCapability(cap)) {
119 final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
120 if (revisionMap != null) {
121 revisionMap.remove(cap.getRevision().get());
122 if (revisionMap.isEmpty()) {
123 mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
129 private static boolean isValidModuleCapability(final Capability cap) {
130 return cap.getModuleName().isPresent()
131 && cap.getRevision().isPresent()
132 && cap.getCapabilitySchema().isPresent();
136 synchronized Capabilities getCapabilities() {
137 return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
140 synchronized AutoCloseable registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
141 listeners.add(listener);
142 listener.onCapabilitiesChanged(getCapabilities());
143 listener.onSchemasChanged(getSchemas());
145 synchronized (NetconfCapabilityMonitoringService.this) {
146 listeners.remove(listener);
151 private static Schemas transformSchemas(final Set<Capability> caps) {
152 final List<Schema> schemas = new ArrayList<>(caps.size());
153 for (final Capability cap : caps) {
154 if (cap.getCapabilitySchema().isPresent()) {
155 final SchemaBuilder builder = new SchemaBuilder();
157 Preconditions.checkState(isValidModuleCapability(cap));
159 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
161 final String version = cap.getRevision().get();
162 builder.setVersion(version);
164 final String identifier = cap.getModuleName().get();
165 builder.setIdentifier(identifier);
167 builder.setFormat(Yang.class);
169 builder.setLocation(transformLocations(cap.getLocation()));
171 builder.withKey(new SchemaKey(Yang.class, identifier, version));
173 schemas.add(builder.build());
177 return new SchemasBuilder().setSchema(schemas).build();
180 private static List<Schema.Location> transformLocations(final Collection<String> locations) {
181 if (locations.isEmpty()) {
182 return NETCONF_LOCATIONS;
185 final Builder<Schema.Location> b = ImmutableList.builder();
186 b.add(NETCONF_LOCATION);
188 for (final String location : locations) {
189 b.add(new Schema.Location(new Uri(location)));
195 private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
196 Set<Capability> capabilities = new HashSet<>(caps);
197 capabilities.add(CANDIDATE_CAPABILITY);
198 // TODO rollback on error not supported EditConfigXmlParser:100
199 // [RFC6241] 8.5. Rollback-on-Error Capability
200 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
205 public synchronized void close() {
207 capabilities.clear();
211 public synchronized void onCapabilitiesChanged(final Set<Capability> added, final Set<Capability> removed) {
212 onCapabilitiesAdded(added);
213 onCapabilitiesRemoved(removed);
214 updateCapabilityToSchemaMap(added, removed);
215 notifyCapabilityChanged(getCapabilities());
217 // publish notification to notification collector about changed capabilities
218 if (notificationPublisher != null) {
219 notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
223 private void notifyCapabilityChanged(final Capabilities newCapabilities) {
224 for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
225 listener.onCapabilitiesChanged(newCapabilities);
226 listener.onSchemasChanged(getSchemas());
231 private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
232 final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
233 netconfCapabilityChangeBuilder
234 .setChangedBy(new ChangedByBuilder().setServerOrUser(
235 new ServerBuilder().setServer(Boolean.TRUE).build()).build());
236 netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2
237 .transform(removed, CAPABILITY_TO_URI)));
238 netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2
239 .transform(added, CAPABILITY_TO_URI)));
240 // TODO modified should be computed ... but why ?
241 netconfCapabilityChangeBuilder.setModifiedCapability(Collections.emptyList());
242 return netconfCapabilityChangeBuilder.build();
246 private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
247 this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
250 private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
251 for (final Capability addedCap : removedCaps) {
252 capabilities.remove(new Uri(addedCap.getCapabilityUri()));
256 void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
257 this.notificationPublisher = notificationPublisher;