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 java.util.Collection;
  11 import java.util.Map;
  12 import java.util.Optional;
  13 import java.util.concurrent.ConcurrentHashMap;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  16 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  17 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
  18 import org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener;
  19 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  20 import org.opendaylight.controller.md.sal.binding.api.MountPoint;
  21 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.sal.binding.api.RpcConsumerRegistry;
  24 import org.opendaylight.transportpce.common.StringConstants;
  25 import org.opendaylight.transportpce.common.Timeouts;
  26 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  27 import org.opendaylight.transportpce.networkmodel.dto.NodeRegistration;
  28 import org.opendaylight.transportpce.networkmodel.listeners.AlarmNotificationListener;
  29 import org.opendaylight.transportpce.networkmodel.listeners.DeOperationsListener;
  30 import org.opendaylight.transportpce.networkmodel.listeners.DeviceListener;
  31 import org.opendaylight.transportpce.networkmodel.listeners.LldpListener;
  32 import org.opendaylight.transportpce.networkmodel.listeners.TcaListener;
  33 import org.opendaylight.transportpce.networkmodel.service.NetworkModelService;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.alarm.rev161014.OrgOpenroadmAlarmListener;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.de.operations.rev161014.OrgOpenroadmDeOperationsListener;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.OrgOpenroadmDeviceListener;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.lldp.rev161014.OrgOpenroadmLldpListener;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.tca.rev161014.OrgOpenroadmTcaListener;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.NotificationsService;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.Netconf;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf.Streams;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  47 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52 public class NetConfTopologyListener implements DataTreeChangeListener<Node> {
  53
  54     private static final Logger LOG = LoggerFactory.getLogger(NetConfTopologyListener.class);
  55
  56     private final NetworkModelService networkModelService;
  57     private final R2RLinkDiscovery linkDiscovery;
  58     private final DataBroker dataBroker;
  59     private final DeviceTransactionManager deviceTransactionManager;
  60     private final Map<String, NodeRegistration> registrations;
  61
  62     public NetConfTopologyListener(final NetworkModelService networkModelService, final DataBroker dataBroker,
  63             final R2RLinkDiscovery linkDiscovery, DeviceTransactionManager deviceTransactionManager) {
  64         this.networkModelService = networkModelService;
  65         this.linkDiscovery = linkDiscovery;
  66         this.dataBroker = dataBroker;
  67         this.deviceTransactionManager = deviceTransactionManager;
  68         this.registrations = new ConcurrentHashMap<>();
  69     }
  70
  71     private void onDeviceConnected(final String nodeId) {
  72         LOG.info("onDeviceConnected: {}", nodeId);
  73         Optional<MountPoint> mountPointOpt = this.deviceTransactionManager.getDeviceMountPoint(nodeId);
  74         MountPoint mountPoint;
  75         if (mountPointOpt.isPresent()) {
  76             mountPoint = mountPointOpt.get();
  77         } else {
  78             LOG.error("Failed to get mount point for node {}", nodeId);
  79             return;
  80         }
  81
  82         final Optional<NotificationService> notificationService =
  83                 mountPoint.getService(NotificationService.class).toJavaUtil();
  84         if (!notificationService.isPresent()) {
  85             LOG.error("Failed to get RpcService for node {}", nodeId);
  86             return;
  87         }
  88
  89         final OrgOpenroadmAlarmListener alarmListener = new AlarmNotificationListener(this.dataBroker);
  90         LOG.info("Registering notification listener on OrgOpenroadmAlarmListener for node: {}", nodeId);
  91         final ListenerRegistration<OrgOpenroadmAlarmListener> accessAlarmNotificationListenerRegistration =
  92                 notificationService.get().registerNotificationListener(alarmListener);
  93
  94         final OrgOpenroadmDeOperationsListener deOperationsListener = new DeOperationsListener();
  95         LOG.info("Registering notification listener on OrgOpenroadmDeOperationsListener for node: {}", nodeId);
  96         final ListenerRegistration<OrgOpenroadmDeOperationsListener>
  97             accessDeOperationasNotificationListenerRegistration =
  98                 notificationService.get().registerNotificationListener(deOperationsListener);
  99
 100         final OrgOpenroadmDeviceListener deviceListener = new DeviceListener();
 101         LOG.info("Registering notification listener on OrgOpenroadmDeviceListener for node: {}", nodeId);
 102         final ListenerRegistration<OrgOpenroadmDeviceListener> accessDeviceNotificationListenerRegistration =
 103                 notificationService.get().registerNotificationListener(deviceListener);
 104
 105         final OrgOpenroadmLldpListener lldpListener = new LldpListener(this.linkDiscovery, nodeId);
 106         LOG.info("Registering notification listener on OrgOpenroadmLldpListener for node: {}", nodeId);
 107         final ListenerRegistration<OrgOpenroadmLldpListener> accessLldpNotificationListenerRegistration =
 108                 notificationService.get().registerNotificationListener(lldpListener);
 109
 110         final OrgOpenroadmTcaListener tcaListener = new TcaListener();
 111         LOG.info("Registering notification listener on OrgOpenroadmTcaListener for node: {}", nodeId);
 112         final ListenerRegistration<OrgOpenroadmTcaListener> accessTcaNotificationListenerRegistration =
 113                 notificationService.get().registerNotificationListener(tcaListener);
 114
 115
 116
 117         String streamName = getSupportedStream(nodeId);
 118         if (streamName == null) {
 119             streamName = "OPENROADM";
 120         }
 121         final Optional<RpcConsumerRegistry> service = mountPoint.getService(RpcConsumerRegistry.class).toJavaUtil();
 122         if (service.isPresent()) {
 123             final NotificationsService rpcService = service.get().getRpcService(NotificationsService.class);
 124             if (rpcService == null) {
 125                 LOG.error("Failed to get RpcService for node {}", nodeId);
 126             } else {
 127                 final CreateSubscriptionInputBuilder createSubscriptionInputBuilder =
 128                     new CreateSubscriptionInputBuilder();
 129                 createSubscriptionInputBuilder.setStream(new StreamNameType(streamName));
 130                 LOG.info("Triggering notification stream {} for node {}", streamName, nodeId);
 131                 rpcService.createSubscription(createSubscriptionInputBuilder.build());
 132             }
 133         } else {
 134             LOG.error("Failed to get RpcService for node {}", nodeId);
 135         }
 136         NodeRegistration nodeRegistration = new NodeRegistration(nodeId, accessAlarmNotificationListenerRegistration,
 137                 accessDeOperationasNotificationListenerRegistration, accessDeviceNotificationListenerRegistration,
 138                 accessLldpNotificationListenerRegistration, accessTcaNotificationListenerRegistration);
 139         this.registrations.put(nodeId, nodeRegistration);
 140     }
 141
 142     private void onDeviceDisConnected(final String nodeId) {
 143         LOG.info("onDeviceDisConnected: {}", nodeId);
 144         NodeRegistration nodeRegistration = this.registrations.remove(nodeId);
 145         if (nodeRegistration != null) {
 146             nodeRegistration.getAccessAlarmNotificationListenerRegistration().close();
 147             nodeRegistration.getAccessDeOperationasNotificationListenerRegistration().close();
 148             nodeRegistration.getAccessDeviceNotificationListenerRegistration().close();
 149             nodeRegistration.getAccessLldpNotificationListenerRegistration().close();
 150             nodeRegistration.getAccessTcaNotificationListenerRegistration().close();
 151         }
 152     }
 153
 154     @Override
 155     @SuppressWarnings("checkstyle:FallThrough")
 156     public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Node>> changes) {
 157         LOG.info("onDataTreeChanged");
 158         for (DataTreeModification<Node> change : changes) {
 159             DataObjectModification<Node> rootNode = change.getRootNode();
 160             if ((rootNode.getDataAfter() == null) && (rootNode.getModificationType() != ModificationType.DELETE)) {
 161                 LOG.error("rootNode.getDataAfter is null : Node not connected via Netconf protocol");
 162                 continue;
 163             }
 164             if (rootNode.getModificationType() == ModificationType.DELETE) {
 165                 if (rootNode.getDataBefore() != null) {
 166                     String nodeId = rootNode.getDataBefore().getKey().getNodeId().getValue();
 167                     LOG.info("Node {} deleted", nodeId);
 168                     this.networkModelService.deleteOpenROADMnode(nodeId);
 169                     onDeviceDisConnected(nodeId);
 170                 } else {
 171                     LOG.error("rootNode.getDataBefore is null !");
 172                 }
 173                 continue;
 174             }
 175             String nodeId = rootNode.getDataAfter().getKey().getNodeId().getValue();
 176             NetconfNode netconfNode = rootNode.getDataAfter().getAugmentation(NetconfNode.class);
 177
 178             if ((netconfNode != null) && !StringConstants.DEFAULT_NETCONF_NODEID.equals(nodeId)) {
 179                 switch (rootNode.getModificationType()) {
 180                     case WRITE:
 181                         LOG.info("Node added: {}", nodeId);
 182                     case SUBTREE_MODIFIED:
 183                         NetconfNodeConnectionStatus.ConnectionStatus connectionStatus =
 184                                 netconfNode.getConnectionStatus();
 185                         try {
 186                             long count = netconfNode.getAvailableCapabilities().getAvailableCapability().stream()
 187                                 .filter(cp -> cp.getCapability().contains(StringConstants.OPENROADM_DEVICE_MODEL_NAME))
 188                                 .count();
 189                             if (count > 0) {
 190                                 LOG.info("OpenROADM node detected: {} {}", nodeId, connectionStatus.name());
 191                                 switch (connectionStatus) {
 192                                     case Connected:
 193                                         this.networkModelService.createOpenROADMnode(nodeId);
 194                                         onDeviceConnected(nodeId);
 195                                         break;
 196                                     case Connecting:
 197                                     case UnableToConnect:
 198                                         this.networkModelService.setOpenROADMnodeStatus(nodeId, connectionStatus);
 199                                         onDeviceDisConnected(nodeId);
 200                                         break;
 201                                     default:
 202                                         LOG.warn("Unsupported device state {}", connectionStatus.getName());
 203                                         break;
 204                                 }
 205                             }
 206                         } catch (NullPointerException e) {
 207                             LOG.error("Cannot get available Capabilities");
 208                         }
 209                         break;
 210                     default:
 211                         LOG.warn("Unexpected connection status : {}", rootNode.getModificationType());
 212                         break;
 213                 }
 214             }
 215         }
 216     }
 217
 218
 219     private String getSupportedStream(String nodeId) {
 220         InstanceIdentifier<Streams> streamsIID = InstanceIdentifier.create(Netconf.class).child(Streams.class);
 221         try {
 222             Optional<Streams> ordmInfoObject =
 223                     this.deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL,
 224                             streamsIID, Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 225             if (!ordmInfoObject.isPresent()) {
 226                 LOG.error("Info subtree is not present");
 227                 return null;
 228             }
 229             for (org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netmod.notification.rev080714.netconf
 230                         .streams.Stream strm : ordmInfoObject.get().getStream()) {
 231
 232                 if ("OPENROADM".equalsIgnoreCase(strm.getName().getValue())) {
 233                     return strm.getName().getValue().toUpperCase();
 234                 }
 235             }
 236             return "NETCONF";
 237         } catch (NullPointerException ex) {
 238             LOG.error("NullPointerException thrown while getting Info from a non Open ROADM device {}", nodeId);
 239             return null;
 240         }
 241     }
 242 }