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.HashSet;
23 import java.util.HashMap;
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.mapping.api.NetconfOperationServiceFactory;
31 import org.opendaylight.netconf.notifications.BaseNotificationPublisherRegistration;
32 import org.opendaylight.netconf.api.monitoring.NetconfManagementSession;
33 import org.opendaylight.netconf.api.monitoring.NetconfMonitoringService;
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.NetconfState;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfStateBuilder;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.Yang;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Capabilities;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.CapabilitiesBuilder;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Schemas;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SchemasBuilder;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.Sessions;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.SessionsBuilder;
44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.Schema;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaBuilder;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.schemas.SchemaKey;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.netconf.state.sessions.Session;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChangeBuilder;
50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.changed.by.parms.ChangedByBuilder;
51 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;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
55 public class NetconfMonitoringServiceImpl implements NetconfMonitoringService, AutoCloseable {
57 private static final Schema.Location NETCONF_LOCATION = new Schema.Location(Schema.Location.Enumeration.NETCONF);
58 private static final List<Schema.Location> NETCONF_LOCATIONS = ImmutableList.of(NETCONF_LOCATION);
59 private static final Logger LOG = LoggerFactory.getLogger(NetconfMonitoringServiceImpl.class);
60 private static final Function<NetconfManagementSession, Session> SESSION_FUNCTION = new Function<NetconfManagementSession, Session>() {
62 public Session apply(@Nonnull final NetconfManagementSession input) {
63 return input.toManagementSession();
66 private static final Function<Capability, Uri> CAPABILITY_TO_URI = new Function<Capability, Uri>() {
68 public Uri apply(final Capability input) {
69 return new Uri(input.getCapabilityUri());
73 private final Set<NetconfManagementSession> sessions = new HashSet<>();
74 private final NetconfOperationServiceFactory netconfOperationProvider;
75 private final Map<Uri, Capability> capabilities = new HashMap<>();
76 private final Map<String, Map<String, String>> mappedModulesToRevisionToSchema = Maps.newHashMap();
78 private final Set<MonitoringListener> listeners = Sets.newHashSet();
79 private volatile BaseNotificationPublisherRegistration notificationPublisher;
81 public NetconfMonitoringServiceImpl(final NetconfOperationServiceFactory netconfOperationProvider) {
82 this.netconfOperationProvider = netconfOperationProvider;
83 netconfOperationProvider.registerCapabilityListener(this);
87 public synchronized void onSessionUp(final NetconfManagementSession session) {
88 LOG.debug("Session {} up", session);
89 Preconditions.checkState(!sessions.contains(session), "Session %s was already added", session);
90 sessions.add(session);
95 public synchronized void onSessionDown(final NetconfManagementSession session) {
96 LOG.debug("Session {} down", session);
97 Preconditions.checkState(sessions.contains(session), "Session %s not present", session);
98 sessions.remove(session);
103 public synchronized Sessions getSessions() {
104 return new SessionsBuilder().setSession(ImmutableList.copyOf(Collections2.transform(sessions, SESSION_FUNCTION))).build();
108 public synchronized Schemas getSchemas() {
110 return transformSchemas(netconfOperationProvider.getCapabilities());
111 } catch (final RuntimeException e) {
113 } catch (final Exception e) {
114 throw new IllegalStateException("Exception while closing", e);
119 public synchronized String getSchemaForCapability(final String moduleName, final Optional<String> revision) {
121 Map<String, String> revisionMapRequest = mappedModulesToRevisionToSchema.get(moduleName);
122 Preconditions.checkState(revisionMapRequest != null, "Capability for module %s not present, " + ""
123 + "available modules : %s", moduleName, Collections2.transform(capabilities.values(), CAPABILITY_TO_URI));
125 if (revision.isPresent()) {
126 String schema = revisionMapRequest.get(revision.get());
128 Preconditions.checkState(schema != null,
129 "Capability for module %s:%s not present, available revisions for module: %s", moduleName,
130 revision.get(), revisionMapRequest.keySet());
134 Preconditions.checkState(revisionMapRequest.size() == 1,
135 "Expected 1 capability for module %s, available revisions : %s", moduleName,
136 revisionMapRequest.keySet());
137 return revisionMapRequest.values().iterator().next();
141 private synchronized void updateCapabilityToSchemaMap(final Set<Capability> added, final Set<Capability> removed) {
142 for (final Capability cap : added) {
143 if (!isValidModuleCapability(cap)){
147 final String currentModuleName = cap.getModuleName().get();
148 Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(currentModuleName);
149 if (revisionMap == null) {
150 revisionMap = Maps.newHashMap();
151 mappedModulesToRevisionToSchema.put(currentModuleName, revisionMap);
154 final String currentRevision = cap.getRevision().get();
155 revisionMap.put(currentRevision, cap.getCapabilitySchema().get());
157 for (final Capability cap : removed) {
158 if (!isValidModuleCapability(cap)){
161 final Map<String, String> revisionMap = mappedModulesToRevisionToSchema.get(cap.getModuleName().get());
162 if (revisionMap != null) {
163 revisionMap.remove(cap.getRevision().get());
164 if (revisionMap.isEmpty()) {
165 mappedModulesToRevisionToSchema.remove(cap.getModuleName().get());
171 private boolean isValidModuleCapability(Capability cap) {
172 return cap.getModuleName().isPresent()
173 && cap.getRevision().isPresent()
174 && cap.getCapabilitySchema().isPresent();
178 public synchronized Capabilities getCapabilities() {
179 return new CapabilitiesBuilder().setCapability(Lists.newArrayList(capabilities.keySet())).build();
183 public synchronized AutoCloseable registerListener(final MonitoringListener listener) {
184 listeners.add(listener);
185 listener.onStateChanged(getCurrentNetconfState());
186 return new AutoCloseable() {
188 public void close() throws Exception {
189 listeners.remove(listener);
194 private NetconfState getCurrentNetconfState() {
195 return new NetconfStateBuilder()
196 .setCapabilities(getCapabilities())
197 .setSchemas(getSchemas())
198 .setSessions(getSessions())
202 private static Schemas transformSchemas(final Set<Capability> caps) {
203 final List<Schema> schemas = new ArrayList<>(caps.size());
204 for (final Capability cap : caps) {
205 if (cap.getCapabilitySchema().isPresent()) {
206 final SchemaBuilder builder = new SchemaBuilder();
207 Preconditions.checkState(cap.getModuleNamespace().isPresent());
208 builder.setNamespace(new Uri(cap.getModuleNamespace().get()));
210 Preconditions.checkState(cap.getRevision().isPresent());
211 final String version = cap.getRevision().get();
212 builder.setVersion(version);
214 Preconditions.checkState(cap.getModuleName().isPresent());
215 final String identifier = cap.getModuleName().get();
216 builder.setIdentifier(identifier);
218 builder.setFormat(Yang.class);
220 builder.setLocation(transformLocations(cap.getLocation()));
222 builder.setKey(new SchemaKey(Yang.class, identifier, version));
224 schemas.add(builder.build());
228 return new SchemasBuilder().setSchema(schemas).build();
231 private static List<Schema.Location> transformLocations(final Collection<String> locations) {
232 if (locations.isEmpty()) {
233 return NETCONF_LOCATIONS;
236 final Builder<Schema.Location> b = ImmutableList.builder();
237 b.add(NETCONF_LOCATION);
239 for (final String location : locations) {
240 b.add(new Schema.Location(new Uri(location)));
246 public static Set<Capability> setupCapabilities(final Set<Capability> caps) {
247 Set<Capability> capabilities = new HashSet<>(caps);
248 capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:candidate:1.0"));
249 // TODO rollback on error not supported EditConfigXmlParser:100
250 // [RFC6241] 8.5. Rollback-on-Error Capability
251 // capabilities.add(new BasicCapability("urn:ietf:params:netconf:capability:rollback-on-error:1.0"));
256 public synchronized void close() throws Exception {
259 capabilities.clear();
263 public void onCapabilitiesChanged(Set<Capability> added, Set<Capability> removed) {
264 onCapabilitiesAdded(added);
265 onCapabilitiesRemoved(removed);
266 updateCapabilityToSchemaMap(added, removed);
269 // publish notification to notification collector about changed capabilities
270 if (notificationPublisher != null) {
271 notificationPublisher.onCapabilityChanged(computeDiff(added, removed));
275 static NetconfCapabilityChange computeDiff(final Set<Capability> added, final Set<Capability> removed) {
276 final NetconfCapabilityChangeBuilder netconfCapabilityChangeBuilder = new NetconfCapabilityChangeBuilder();
277 netconfCapabilityChangeBuilder.setChangedBy(new ChangedByBuilder().setServerOrUser(new ServerBuilder().setServer(true).build()).build());
278 netconfCapabilityChangeBuilder.setDeletedCapability(Lists.newArrayList(Collections2.transform(removed, CAPABILITY_TO_URI)));
279 netconfCapabilityChangeBuilder.setAddedCapability(Lists.newArrayList(Collections2.transform(added, CAPABILITY_TO_URI)));
280 // TODO modified should be computed ... but why ?
281 netconfCapabilityChangeBuilder.setModifiedCapability(Collections.<Uri>emptyList());
282 return netconfCapabilityChangeBuilder.build();
286 private synchronized void onCapabilitiesAdded(final Set<Capability> addedCaps) {
287 // FIXME howto check for duplicates
288 this.capabilities.putAll(Maps.uniqueIndex(setupCapabilities(addedCaps), CAPABILITY_TO_URI));
291 private void notifyListeners() {
292 for (final MonitoringListener listener : listeners) {
293 listener.onStateChanged(getCurrentNetconfState());
297 private synchronized void onCapabilitiesRemoved(final Set<Capability> addedCaps) {
298 for (final Capability addedCap : addedCaps) {
299 capabilities.remove(CAPABILITY_TO_URI.apply(addedCap));
303 public void setNotificationPublisher(final BaseNotificationPublisherRegistration notificationPublisher) {
304 this.notificationPublisher = notificationPublisher;