2 * Copyright © 2016 Orange 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.transportpce.networkmodel;
10 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
12 import java.util.Collection;
13 import java.util.Collections;
14 import java.util.List;
16 import java.util.Optional;
17 import java.util.concurrent.ConcurrentHashMap;
18 import java.util.stream.Collectors;
19 import javax.annotation.Nonnull;
21 import org.opendaylight.mdsal.binding.api.DataBroker;
22 import org.opendaylight.mdsal.binding.api.DataObjectModification;
23 import org.opendaylight.mdsal.binding.api.DataObjectModification.ModificationType;
24 import org.opendaylight.mdsal.binding.api.DataTreeChangeListener;
25 import org.opendaylight.mdsal.binding.api.DataTreeModification;
26 import org.opendaylight.mdsal.binding.api.MountPoint;
27 import org.opendaylight.mdsal.binding.api.NotificationService;
28 import org.opendaylight.mdsal.binding.api.RpcConsumerRegistry;
29 import org.opendaylight.transportpce.common.StringConstants;
30 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
31 import org.opendaylight.transportpce.networkmodel.dto.NodeRegistration;
32 import org.opendaylight.transportpce.networkmodel.dto.NodeRegistration22;
33 import org.opendaylight.transportpce.networkmodel.listeners.AlarmNotificationListener;
34 import org.opendaylight.transportpce.networkmodel.listeners.AlarmNotificationListener221;
35 import org.opendaylight.transportpce.networkmodel.listeners.DeOperationsListener;
36 import org.opendaylight.transportpce.networkmodel.listeners.DeOperationsListener221;
37 import org.opendaylight.transportpce.networkmodel.listeners.DeviceListener;
38 import org.opendaylight.transportpce.networkmodel.listeners.DeviceListener221;
39 import org.opendaylight.transportpce.networkmodel.listeners.TcaListener;
40 import org.opendaylight.transportpce.networkmodel.listeners.TcaListener221;
41 import org.opendaylight.transportpce.networkmodel.service.NetworkModelService;
42 import org.opendaylight.yang.gen.v1.http.org.openroadm.alarm.rev161014.OrgOpenroadmAlarmListener;
43 import org.opendaylight.yang.gen.v1.http.org.openroadm.de.operations.rev161014.OrgOpenroadmDeOperationsListener;
44 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.OrgOpenroadmDeviceListener;
45 import org.opendaylight.yang.gen.v1.http.org.openroadm.tca.rev161014.OrgOpenroadmTcaListener;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.NotificationsService;
48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
52 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
53 import org.opendaylight.yangtools.concepts.ListenerRegistration;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 public class NetConfTopologyListener implements DataTreeChangeListener<Node> {
59 private static final Logger LOG = LoggerFactory.getLogger(NetConfTopologyListener.class);
61 private final NetworkModelService networkModelService;
62 private final DataBroker dataBroker;
63 private final DeviceTransactionManager deviceTransactionManager;
64 private final Map<String, NodeRegistration> registrations;
65 private final Map<String, NodeRegistration22> registrations22;
67 public NetConfTopologyListener(final NetworkModelService networkModelService, final DataBroker dataBroker,
68 DeviceTransactionManager deviceTransactionManager) {
69 this.networkModelService = networkModelService;
70 this.dataBroker = dataBroker;
71 this.deviceTransactionManager = deviceTransactionManager;
72 this.registrations = new ConcurrentHashMap<>();
73 this.registrations22 = new ConcurrentHashMap<>();
77 value = "RV_RETURN_VALUE_IGNORED",
78 justification = "nothing to verify once rpc has been sent")
79 private void onDeviceConnected(final String nodeId, String openRoadmVersion) {
80 LOG.info("onDeviceConnected: {}", nodeId);
81 Optional<MountPoint> mountPointOpt = this.deviceTransactionManager.getDeviceMountPoint(nodeId);
82 MountPoint mountPoint;
83 if (mountPointOpt.isPresent()) {
84 mountPoint = mountPointOpt.get();
86 LOG.error("Failed to get mount point for node {}", nodeId);
90 final Optional<NotificationService> notificationService =
91 mountPoint.getService(NotificationService.class);
92 if (!notificationService.isPresent()) {
93 LOG.error("Failed to get RpcService for node {}", nodeId);
97 if (openRoadmVersion.equals(StringConstants.OPENROADM_DEVICE_VERSION_1_2_1)) {
99 final OrgOpenroadmAlarmListener alarmListener = new AlarmNotificationListener(this.dataBroker);
100 LOG.info("Registering notification listener on OrgOpenroadmAlarmListener for node: {}", nodeId);
101 final ListenerRegistration<OrgOpenroadmAlarmListener> accessAlarmNotificationListenerRegistration =
102 notificationService.get().registerNotificationListener(alarmListener);
104 final OrgOpenroadmDeOperationsListener deOperationsListener = new DeOperationsListener();
105 LOG.info("Registering notification listener on OrgOpenroadmDeOperationsListener for node: {}", nodeId);
106 final ListenerRegistration<OrgOpenroadmDeOperationsListener>
107 accessDeOperationasNotificationListenerRegistration =
108 notificationService.get().registerNotificationListener(deOperationsListener);
110 final OrgOpenroadmDeviceListener deviceListener = new DeviceListener();
111 LOG.info("Registering notification listener on OrgOpenroadmDeviceListener for node: {}", nodeId);
112 final ListenerRegistration<OrgOpenroadmDeviceListener> accessDeviceNotificationListenerRegistration =
113 notificationService.get().registerNotificationListener(deviceListener);
115 TcaListener tcaListener = new TcaListener();
116 LOG.info("Registering notification listener on OrgOpenroadmTcaListener for node: {}", nodeId);
117 final ListenerRegistration<OrgOpenroadmTcaListener> accessTcaNotificationListenerRegistration =
118 notificationService.get().registerNotificationListener(tcaListener);
120 String streamName = "NETCONF";
122 if (streamName == null) {
123 streamName = "OPENROADM";
126 final Optional<RpcConsumerRegistry> service = mountPoint.getService(RpcConsumerRegistry.class);
127 if (service.isPresent()) {
128 final NotificationsService rpcService = service.get().getRpcService(NotificationsService.class);
129 if (rpcService == null) {
130 LOG.error("Failed to get RpcService for node {}", nodeId);
132 final CreateSubscriptionInputBuilder createSubscriptionInputBuilder =
133 new CreateSubscriptionInputBuilder();
134 createSubscriptionInputBuilder.setStream(new StreamNameType(streamName));
135 LOG.info("Triggering notification stream {} for node {}", streamName, nodeId);
136 rpcService.createSubscription(createSubscriptionInputBuilder.build());
139 LOG.error("Failed to get RpcService for node {}", nodeId);
141 NodeRegistration nodeRegistration = new NodeRegistration(nodeId,
142 accessAlarmNotificationListenerRegistration,
143 accessDeOperationasNotificationListenerRegistration, accessDeviceNotificationListenerRegistration,
144 null, accessTcaNotificationListenerRegistration);
145 registrations.put(nodeId, nodeRegistration);
147 } else if (openRoadmVersion.equals(StringConstants.OPENROADM_DEVICE_VERSION_2_2_1)) {
148 final org.opendaylight.yang.gen.v1.http.org.openroadm.alarm.rev181019.OrgOpenroadmAlarmListener
149 alarmListener = new AlarmNotificationListener221(dataBroker);
150 LOG.info("Registering notification listener on OrgOpenroadmAlarmListener for node: {}", nodeId);
151 final ListenerRegistration<org.opendaylight.yang.gen.v1.http.org.openroadm.alarm.rev181019
152 .OrgOpenroadmAlarmListener> accessAlarmNotificationListenerRegistration =
153 notificationService.get().registerNotificationListener(alarmListener);
155 final org.opendaylight.yang.gen.v1.http.org.openroadm.de.operations.rev181019
156 .OrgOpenroadmDeOperationsListener deOperationsListener = new DeOperationsListener221();
157 LOG.info("Registering notification listener on OrgOpenroadmDeOperationsListener for node: {}", nodeId);
158 final ListenerRegistration<org.opendaylight.yang.gen.v1.http.org.openroadm.de.operations.rev181019
159 .OrgOpenroadmDeOperationsListener> accessDeOperationasNotificationListenerRegistration =
160 notificationService.get().registerNotificationListener(deOperationsListener);
162 final org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.OrgOpenroadmDeviceListener
163 deviceListener = new DeviceListener221();
164 LOG.info("Registering notification listener on OrgOpenroadmDeviceListener for node: {}", nodeId);
165 final ListenerRegistration<org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019
166 .OrgOpenroadmDeviceListener> accessDeviceNotificationListenerRegistration =
167 notificationService.get().registerNotificationListener(deviceListener);
169 final org.opendaylight.yang.gen.v1.http.org.openroadm.tca.rev181019.OrgOpenroadmTcaListener
170 tcaListener = new TcaListener221();
171 LOG.info("Registering notification listener on OrgOpenroadmTcaListener for node: {}", nodeId);
172 final ListenerRegistration<org.opendaylight.yang.gen.v1.http.org.openroadm.tca.rev181019
173 .OrgOpenroadmTcaListener> accessTcaNotificationListenerRegistration =
174 notificationService.get().registerNotificationListener(tcaListener);
177 String streamName = "NETCONF";
178 if (streamName == null) {
179 streamName = "OPENROADM";
181 final Optional<RpcConsumerRegistry> service = mountPoint.getService(RpcConsumerRegistry.class);
182 if (service.isPresent()) {
183 final NotificationsService rpcService = service.get().getRpcService(NotificationsService.class);
184 if (rpcService == null) {
185 LOG.error("Failed to get RpcService for node {}", nodeId);
187 final CreateSubscriptionInputBuilder createSubscriptionInputBuilder =
188 new CreateSubscriptionInputBuilder();
189 createSubscriptionInputBuilder.setStream(new StreamNameType(streamName));
190 LOG.info("Triggering notification stream {} for node {}", streamName, nodeId);
191 rpcService.createSubscription(createSubscriptionInputBuilder.build());
194 LOG.error("Failed to get RpcService for node {}", nodeId);
196 NodeRegistration22 nodeRegistration22 = new NodeRegistration22(nodeId,
197 accessAlarmNotificationListenerRegistration,
198 accessDeOperationasNotificationListenerRegistration, accessDeviceNotificationListenerRegistration,
199 null, accessTcaNotificationListenerRegistration);
200 registrations22.put(nodeId, nodeRegistration22);
206 private void onDeviceDisConnected(final String nodeId) {
207 LOG.info("onDeviceDisConnected: {}", nodeId);
208 NodeRegistration nodeRegistration = this.registrations.remove(nodeId);
209 if (nodeRegistration != null) {
210 nodeRegistration.getAccessAlarmNotificationListenerRegistration().close();
211 nodeRegistration.getAccessDeOperationasNotificationListenerRegistration().close();
212 nodeRegistration.getAccessDeviceNotificationListenerRegistration().close();
213 nodeRegistration.getAccessTcaNotificationListenerRegistration().close();
219 value = "SF_SWITCH_FALLTHROUGH",
220 justification = "intentional fallthrough")
221 public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Node>> changes) {
222 LOG.info("onDataTreeChanged");
223 for (DataTreeModification<Node> change : changes) {
224 DataObjectModification<Node> rootNode = change.getRootNode();
225 if ((rootNode.getDataAfter() == null) && (rootNode.getModificationType() != ModificationType.DELETE)) {
226 LOG.error("rootNode.getDataAfter is null : Node not connected via Netconf protocol");
229 if (rootNode.getModificationType() == ModificationType.DELETE) {
230 if (rootNode.getDataBefore() != null) {
231 String nodeId = rootNode.getDataBefore().key().getNodeId().getValue();
232 LOG.info("Node {} deleted", nodeId);
233 this.networkModelService.deleteOpenRoadmnode(nodeId);
234 onDeviceDisConnected(nodeId);
236 LOG.error("rootNode.getDataBefore is null !");
240 String nodeId = rootNode.getDataAfter().key().getNodeId().getValue();
241 NetconfNode netconfNode = rootNode.getDataAfter().augmentation(NetconfNode.class);
243 if ((netconfNode != null) && !StringConstants.DEFAULT_NETCONF_NODEID.equals(nodeId)) {
244 switch (rootNode.getModificationType()) {
246 LOG.info("Node added: {}", nodeId);
248 case SUBTREE_MODIFIED:
249 NetconfNodeConnectionStatus.ConnectionStatus connectionStatus =
250 netconfNode.getConnectionStatus();
252 List<AvailableCapability> deviceCapabilities = netconfNode.getAvailableCapabilities()
253 .getAvailableCapability().stream().filter(cp -> cp.getCapability()
254 .contains(StringConstants.OPENROADM_DEVICE_MODEL_NAME)).collect(Collectors.toList());
255 if (!deviceCapabilities.isEmpty()) {
256 Collections.sort(deviceCapabilities, (cp0, cp1) -> cp1.getCapability()
257 .compareTo(cp0.getCapability()));
258 LOG.info("OpenROADM node detected: {} {}", nodeId, connectionStatus.name());
259 switch (connectionStatus) {
261 this.networkModelService.createOpenRoadmNode(nodeId, deviceCapabilities.get(0)
263 onDeviceConnected(nodeId,deviceCapabilities.get(0).getCapability());
266 case UnableToConnect:
267 this.networkModelService.setOpenRoadmNodeStatus(nodeId, connectionStatus);
268 onDeviceDisConnected(nodeId);
271 LOG.warn("Unsupported device state {}", connectionStatus.getName());
276 } catch (NullPointerException e) {
277 LOG.error("Cannot get available Capabilities");
281 LOG.warn("Unexpected connection status : {}", rootNode.getModificationType());
289 /*private String getSupportedStream(String nodeId) {
290 InstanceIdentifier<Streams> streamsIID = InstanceIdentifier.create(Netconf.class).child(Streams.class);
292 Optional<Streams> ordmInfoObject =
293 this.deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL,
294 streamsIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
295 if (!ordmInfoObject.isPresent()) {
296 LOG.error("Get Stream RPC is not supported");
299 for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf
300 .streams.Stream strm : ordmInfoObject.get().getStream()) {
302 if ("OPENROADM".equalsIgnoreCase(strm.getName().getValue())) {
303 return strm.getName().getValue().toUpperCase();
307 } catch (NullPointerException ex) {
308 LOG.error("NullPointerException thrown while getting Info from a non Open ROADM device {}", nodeId);