2 * Copyright (c) 2013 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 javax.annotation.Nonnull;
28 import org.opendaylight.controller.config.util.capability.BasicCapability;
29 import org.opendaylight.controller.config.util.capability.Capability;
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.Sessions;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SessionsBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
49 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;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
53 public class NetconfMonitoringServiceImpl implements NetconfMonitoringService, AutoCloseable {
55 private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
56 private static final List<Schema.Location> NETCONF_LOCATIONS = ImmutableList.of(NETCONF_LOCATION);
57 private static final Logger LOG = LoggerFactory.getLogger(NetconfMonitoringServiceImpl.class);
58 private static final Function<NetconfManagementSession, Session> SESSION_FUNCTION = new Function<NetconfManagementSession, Session>() {
60 public Session apply(@Nonnull final NetconfManagementSession input) {
61 return input.toManagementSession();
64 private static final Function<Capability, Uri> CAPABILITY_TO_URI = new Function<Capability, Uri>() {
66 public Uri apply(final Capability input) {
67 return new Uri(input.getCapabilityUri());
71 private final Set<NetconfManagementSession> sessions = new HashSet<>();
72 private final NetconfOperationServiceFactory netconfOperationProvider;
73 private final Map<Uri, Capability> capabilities = new HashMap<>();
74 private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
76 private final Set<MonitoringListener> listeners = Sets.newHashSet();
77 private volatile BaseNotificationPublisherRegistration notificationPublisher;
79 public NetconfMonitoringServiceImpl(final NetconfOperationServiceFactory netconfOperationProvider) {
80 this.netconfOperationProvider = netconfOperationProvider;
81 netconfOperationProvider.registerCapabilityListener(this);
85 public synchronized void onSessionUp(final NetconfManagementSession session) {
86 LOG.debug("Session {} up", session);
87 Preconditions.checkState(!sessions.contains(session), "Session %s was already added", session);
88 sessions.add(session);
89 notifySessionUp(session);
93 public synchronized void onSessionDown(final NetconfManagementSession session) {
94 LOG.debug("Session {} down", session);
95 Preconditions.checkState(sessions.contains(session), "Session %s not present", session);
96 sessions.remove(session);
97 notifySessionDown(session);
101 public synchronized Sessions getSessions() {
102 return new SessionsBuilder().setSession(ImmutableList.copyOf(Collections2.transform(sessions, SESSION_FUNCTION))).build();
106 public synchronized Schemas getSchemas() {
108 return transformSchemas(netconfOperationProvider.getCapabilities());
109 } catch (final RuntimeException e) {
111 } catch (final Exception e) {
112 throw new IllegalStateException("Exception while closing", e);
117 public synchronized String getSchemaForCapability(final String moduleName, final Optional<String> revision) {
119 Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
120 Preconditions.checkState(revisionMapRequest != null, "Capability for module %s not present, " + ""
121 + "available modules : %s", moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
123 if (revision.isPresent()) {
124 String schema = revisionMapRequest.get(revision.get());
126 Preconditions.checkState(schema != null,
127 "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
128 revision.get(), revisionMapRequest.keySet());
132 Preconditions.checkState(revisionMapRequest.size() == 1,
133 "Expected 1 capability for module %s, available revisions : %s", moduleName,
134 revisionMapRequest.keySet());
135 return revisionMapRequest.values().iterator().next();
139 private synchronized void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
140 for (final Capability cap : added) {
141 if (!isValidModuleCapability(cap)){
145 final String currentModuleName = cap.getModuleName().get();
146 Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(currentModuleName);
147 if (revisionMap == null) {
148 revisionMap = Maps.newHashMap();
149 mappedModulesToRevisionToSchema.put(currentModuleName, revisionMap);
152 final String currentRevision = cap.getRevision().get();
153 revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
155 for (final Capability cap : removed) {
156 if (!isValidModuleCapability(cap)){
159 final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
160 if (revisionMap != null) {
161 revisionMap.remove(cap.getRevision().get());
162 if (revisionMap.isEmpty()) {
163 mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
169 private boolean isValidModuleCapability(Capability cap) {
170 return cap.getModuleName().isPresent()
171 && cap.getRevision().isPresent()
172 && cap.getCapabilitySchema().isPresent();
176 public synchronized Capabilities getCapabilities() {
177 return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
181 public synchronized AutoCloseable registerListener(final MonitoringListener listener) {
182 listeners.add(listener);
183 listener.onCapabilitiesChanged(getCapabilities());
184 listener.onSchemasChanged(getSchemas());
185 return new AutoCloseable() {
187 public void close() throws Exception {
188 listeners.remove(listener);
193 private static Schemas transformSchemas(final Set<Capability> caps) {
194 final List<Schema> schemas = new ArrayList<>(caps.size());
195 for (final Capability cap : caps) {
196 if (cap.getCapabilitySchema().isPresent()) {
197 final SchemaBuilder builder = new SchemaBuilder();
198 Preconditions.checkState(cap.getModuleNamespace().isPresent());
199 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
201 Preconditions.checkState(cap.getRevision().isPresent());
202 final String version = cap.getRevision().get();
203 builder.setVersion(version);
205 Preconditions.checkState(cap.getModuleName().isPresent());
206 final String identifier = cap.getModuleName().get();
207 builder.setIdentifier(identifier);
209 builder.setFormat(Yang.class);
211 builder.setLocation(transformLocations(cap.getLocation()));
213 builder.setKey(new SchemaKey(Yang.class, identifier, version));
215 schemas.add(builder.build());
219 return new SchemasBuilder().setSchema(schemas).build();
222 private static List<Schema.Location> transformLocations(final Collection<String> locations) {
223 if (locations.isEmpty()) {
224 return NETCONF_LOCATIONS;
227 final Builder<Schema.Location> b = ImmutableList.builder();
228 b.add(NETCONF_LOCATION);
230 for (final String location : locations) {
231 b.add(new Schema.Location(new Uri(location)));
237 public static Set<Capability> setupCapabilities(final Set<Capability> caps) {
238 Set<Capability> capabilities = new HashSet<>(caps);
239 capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
240 // TODO rollback on error not supported EditConfigXmlParser:100
241 // [RFC6241] 8.5. Rollback-on-Error Capability
242 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
247 public synchronized void close() throws Exception {
250 capabilities.clear();
254 public void onCapabilitiesChanged(Set<Capability> added, Set<Capability> removed) {
255 onCapabilitiesAdded(added);
256 onCapabilitiesRemoved(removed);
257 updateCapabilityToSchemaMap(added, removed);
258 notifyCapabilityChanged(getCapabilities());
260 // publish notification to notification collector about changed capabilities
261 if (notificationPublisher != null) {
262 notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
266 private void notifyCapabilityChanged(Capabilities capabilities) {
267 for (MonitoringListener listener : listeners) {
268 listener.onCapabilitiesChanged(capabilities);
269 listener.onSchemasChanged(getSchemas());
273 private void notifySessionUp(NetconfManagementSession managementSession) {
274 Session session = SESSION_FUNCTION.apply(managementSession);
275 for (MonitoringListener listener : listeners) {
276 listener.onSessionStarted(session);
280 private void notifySessionDown(NetconfManagementSession managementSession) {
281 Session session = SESSION_FUNCTION.apply(managementSession);
282 for (MonitoringListener listener : listeners) {
283 listener.onSessionEnded(session);
287 static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
288 final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
289 netconfCapabilityChangeBuilder.setChangedBy(new ChangedByBuilder().setServerOrUser(new ServerBuilder().setServer(true).build()).build());
290 netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2.transform(removed, CAPABILITY_TO_URI)));
291 netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2.transform(added, CAPABILITY_TO_URI)));
292 // TODO modified should be computed ... but why ?
293 netconfCapabilityChangeBuilder.setModifiedCapability(Collections.<Uri>emptyList());
294 return netconfCapabilityChangeBuilder.build();
298 private synchronized void onCapabilitiesAdded(final Set<Capability> addedCaps) {
299 this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
302 private synchronized void onCapabilitiesRemoved(final Set<Capability> addedCaps) {
303 for (final Capability addedCap : addedCaps) {
304 capabilities.remove(CAPABILITY_TO_URI.apply(addedCap));
308 public void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
309 this.notificationPublisher = notificationPublisher;