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.HashMap;
23 import java.util.HashSet;
24 import java.util.List;
27 import org.opendaylight.controller.config.util.capability.BasicCapability;
28 import org.opendaylight.controller.config.util.capability.Capability;
29 import org.opendaylight.netconf.api.monitoring.CapabilityListener;
30 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
31 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
32 import org.opendaylight.netconf.mapping.api.NetconfOperationServiceFactory;
33 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.Uri;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
46 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;
48 class NetconfCapabilityMonitoringService implements CapabilityListener, AutoCloseable {
50 private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
51 private static final List<Schema.Location> NETCONF_LOCATIONS = ImmutableList.of(NETCONF_LOCATION);
52 private static final BasicCapability CANDIDATE_CAPABILITY = new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0");
53 private static final Function<Capability, Uri> CAPABILITY_TO_URI = new Function<Capability, Uri>() {
55 public Uri apply(final Capability input) {
56 return new Uri(input.getCapabilityUri());
60 private final Set<NetconfManagementSession> sessions = new HashSet<>();
61 private final NetconfOperationServiceFactory netconfOperationProvider;
62 private final Map<Uri, Capability> capabilities = new HashMap<>();
63 private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
66 private final Set<NetconfMonitoringService.CapabilitiesListener> listeners = Sets.newHashSet();
67 private volatile BaseNotificationPublisherRegistration notificationPublisher;
69 NetconfCapabilityMonitoringService(final NetconfOperationServiceFactory netconfOperationProvider) {
70 this.netconfOperationProvider = netconfOperationProvider;
71 netconfOperationProvider.registerCapabilityListener(this);
74 synchronized Schemas getSchemas() {
76 return transformSchemas(netconfOperationProvider.getCapabilities());
77 } catch (final RuntimeException e) {
79 } catch (final Exception e) {
80 throw new IllegalStateException("Exception while closing", e);
84 synchronized String getSchemaForModuleRevision(final String moduleName, final Optional<String> revision) {
86 Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
87 Preconditions.checkState(revisionMapRequest != null, "Capability for module %s not present, " + ""
88 + "available modules : %s", moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
90 if (revision.isPresent()) {
91 String schema = revisionMapRequest.get(revision.get());
93 Preconditions.checkState(schema != null,
94 "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
95 revision.get(), revisionMapRequest.keySet());
99 Preconditions.checkState(revisionMapRequest.size() == 1,
100 "Expected 1 capability for module %s, available revisions : %s", moduleName,
101 revisionMapRequest.keySet());
102 //Only one revision is present, so return it
103 return revisionMapRequest.values().iterator().next();
107 private void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
108 for (final Capability cap : added) {
109 if (!isValidModuleCapability(cap)){
113 final String currentModuleName = cap.getModuleName().get();
114 Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(currentModuleName);
115 if (revisionMap == null) {
116 revisionMap = Maps.newHashMap();
117 mappedModulesToRevisionToSchema.put(currentModuleName, revisionMap);
120 final String currentRevision = cap.getRevision().get();
121 revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
123 for (final Capability cap : removed) {
124 if (!isValidModuleCapability(cap)){
127 final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
128 if (revisionMap != null) {
129 revisionMap.remove(cap.getRevision().get());
130 if (revisionMap.isEmpty()) {
131 mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
137 private static boolean isValidModuleCapability(Capability cap) {
138 return cap.getModuleName().isPresent()
139 && cap.getRevision().isPresent()
140 && cap.getCapabilitySchema().isPresent();
144 synchronized Capabilities getCapabilities() {
145 return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
148 synchronized AutoCloseable registerListener(final NetconfMonitoringService.CapabilitiesListener listener) {
149 listeners.add(listener);
150 listener.onCapabilitiesChanged(getCapabilities());
151 listener.onSchemasChanged(getSchemas());
152 return new AutoCloseable() {
154 public void close() throws Exception {
155 synchronized (NetconfCapabilityMonitoringService.this) {
156 listeners.remove(listener);
162 private static Schemas transformSchemas(final Set<Capability> caps) {
163 final List<Schema> schemas = new ArrayList<>(caps.size());
164 for (final Capability cap : caps) {
165 if (cap.getCapabilitySchema().isPresent()) {
166 final SchemaBuilder builder = new SchemaBuilder();
168 Preconditions.checkState(isValidModuleCapability(cap));
170 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
172 final String version = cap.getRevision().get();
173 builder.setVersion(version);
175 final String identifier = cap.getModuleName().get();
176 builder.setIdentifier(identifier);
178 builder.setFormat(Yang.class);
180 builder.setLocation(transformLocations(cap.getLocation()));
182 builder.setKey(new SchemaKey(Yang.class, identifier, version));
184 schemas.add(builder.build());
188 return new SchemasBuilder().setSchema(schemas).build();
191 private static List<Schema.Location> transformLocations(final Collection<String> locations) {
192 if (locations.isEmpty()) {
193 return NETCONF_LOCATIONS;
196 final Builder<Schema.Location> b = ImmutableList.builder();
197 b.add(NETCONF_LOCATION);
199 for (final String location : locations) {
200 b.add(new Schema.Location(new Uri(location)));
206 private static Set<Capability> setupCapabilities(final Set<Capability> caps) {
207 Set<Capability> capabilities = new HashSet<>(caps);
208 capabilities.add(CANDIDATE_CAPABILITY);
209 // TODO rollback on error not supported EditConfigXmlParser:100
210 // [RFC6241] 8.5. Rollback-on-Error Capability
211 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
216 public synchronized void close() throws Exception {
219 capabilities.clear();
223 public synchronized void onCapabilitiesChanged(Set<Capability> added, Set<Capability> removed) {
224 onCapabilitiesAdded(added);
225 onCapabilitiesRemoved(removed);
226 updateCapabilityToSchemaMap(added, removed);
227 notifyCapabilityChanged(getCapabilities());
229 // publish notification to notification collector about changed capabilities
230 if (notificationPublisher != null) {
231 notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
235 private void notifyCapabilityChanged(Capabilities capabilities) {
236 for (NetconfMonitoringService.CapabilitiesListener listener : listeners) {
237 listener.onCapabilitiesChanged(capabilities);
238 listener.onSchemasChanged(getSchemas());
243 private static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
244 final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
245 netconfCapabilityChangeBuilder.setChangedBy(new ChangedByBuilder().setServerOrUser(new ServerBuilder().setServer(true).build()).build());
246 netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2.transform(removed, CAPABILITY_TO_URI)));
247 netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2.transform(added, CAPABILITY_TO_URI)));
248 // TODO modified should be computed ... but why ?
249 netconfCapabilityChangeBuilder.setModifiedCapability(Collections.<Uri>emptyList());
250 return netconfCapabilityChangeBuilder.build();
254 private void onCapabilitiesAdded(final Set<Capability> addedCaps) {
255 this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
258 private void onCapabilitiesRemoved(final Set<Capability> removedCaps) {
259 for (final Capability addedCap : removedCaps) {
260 capabilities.remove(CAPABILITY_TO_URI.apply(addedCap));
264 void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
265 this.notificationPublisher = notificationPublisher;