networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/NetConfTopologyListener.java

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