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 com.google.common.annotations.VisibleForTesting;
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import java.util.Collection;
  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.concurrent.ExecutionException;
  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.DataTreeChangeListener;
  22 import org.opendaylight.mdsal.binding.api.DataTreeModification;
  23 import org.opendaylight.mdsal.binding.api.MountPoint;
  24 import org.opendaylight.mdsal.binding.api.NotificationService;
  25 import org.opendaylight.mdsal.binding.api.RpcConsumerRegistry;
  26 import org.opendaylight.transportpce.common.StringConstants;
  27 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  28 import org.opendaylight.transportpce.common.mapping.PortMapping;
  29 import org.opendaylight.transportpce.networkmodel.dto.NodeRegistration;
  30 import org.opendaylight.transportpce.networkmodel.service.NetworkModelService;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInputBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionOutput;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.NotificationsService;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.StreamNameType;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  39 import org.opendaylight.yangtools.yang.common.RpcResult;
  40 import org.slf4j.Logger;
  41 import org.slf4j.LoggerFactory;
  42
  43 public class NetConfTopologyListener implements DataTreeChangeListener<Node> {
  44
  45     private static final Logger LOG = LoggerFactory.getLogger(NetConfTopologyListener.class);
  46     private static final String RPC_SERVICE_FAILED = "Failed to get RpcService for node {}";
  47     private final NetworkModelService networkModelService;
  48     private final DataBroker dataBroker;
  49     private final DeviceTransactionManager deviceTransactionManager;
  50     private final Map<String, NodeRegistration> registrations;
  51     private final PortMapping portMapping;
  52
  53     public NetConfTopologyListener(
  54             final NetworkModelService networkModelService,
  55             final DataBroker dataBroker,
  56             DeviceTransactionManager deviceTransactionManager,
  57             PortMapping portMapping) {
  58         this.networkModelService = networkModelService;
  59         this.dataBroker = dataBroker;
  60         this.deviceTransactionManager = deviceTransactionManager;
  61         this.registrations = new ConcurrentHashMap<>();
  62         this.portMapping = portMapping;
  63     }
  64
  65     public void onDataTreeChanged(@Nonnull Collection<DataTreeModification<Node>> changes) {
  66         LOG.info("onDataTreeChanged - {}", this.getClass().getSimpleName());
  67         for (DataTreeModification<Node> change : changes) {
  68             DataObjectModification<Node> rootNode = change.getRootNode();
  69             if (rootNode.getDataBefore() == null) {
  70                 continue;
  71             }
  72             String nodeId = rootNode.getDataBefore().key().getNodeId().getValue();
  73             NetconfNode netconfNodeBefore = rootNode.getDataBefore().augmentation(NetconfNode.class);
  74             switch (rootNode.getModificationType()) {
  75                 case DELETE:
  76                     if (this.networkModelService.deleteOpenRoadmnode(nodeId)) {
  77                         onDeviceDisConnected(nodeId);
  78                         LOG.info("Device {} correctly disconnected from controller", nodeId);
  79                     }
  80                     break;
  81                 case WRITE:
  82                     NetconfNode netconfNodeAfter = rootNode.getDataAfter().augmentation(NetconfNode.class);
  83                     if (ConnectionStatus.Connecting.equals(netconfNodeBefore.getConnectionStatus())
  84                             && ConnectionStatus.Connected.equals(netconfNodeAfter.getConnectionStatus())) {
  85                         LOG.info("Connecting Node: {}", nodeId);
  86                         Optional<AvailableCapability> deviceCapabilityOpt =
  87                             netconfNodeAfter.getAvailableCapabilities().getAvailableCapability().stream()
  88                                 .filter(cp -> cp.getCapability().contains(StringConstants.OPENROADM_DEVICE_MODEL_NAME))
  89                                 .sorted((c1, c2) -> c2.getCapability().compareTo(c1.getCapability()))
  90                                 .findFirst();
  91                         if (deviceCapabilityOpt.isEmpty()) {
  92                             LOG.error("Unable to get openroadm-device-capability");
  93                             return;
  94                         }
  95                         this.networkModelService
  96                             .createOpenRoadmNode(nodeId, deviceCapabilityOpt.get().getCapability());
  97                         onDeviceConnected(nodeId, deviceCapabilityOpt.get().getCapability());
  98                         LOG.info("Device {} correctly connected to controller", nodeId);
  99                     }
 100                     if (ConnectionStatus.Connected.equals(netconfNodeBefore.getConnectionStatus())
 101                             && ConnectionStatus.Connecting.equals(netconfNodeAfter.getConnectionStatus())) {
 102                         LOG.warn("Node: {} is being disconnected", nodeId);
 103                     }
 104                     break;
 105                 default:
 106                     LOG.debug("Unknown modification type {}", rootNode.getModificationType().name());
 107                     break;
 108             }
 109         }
 110     }
 111
 112     private void onDeviceConnected(final String nodeId, String openRoadmVersion) {
 113         LOG.info("onDeviceConnected: {}", nodeId);
 114         Optional<MountPoint> mountPointOpt = this.deviceTransactionManager.getDeviceMountPoint(nodeId);
 115         if (mountPointOpt.isEmpty()) {
 116             LOG.error("Failed to get mount point for node {}", nodeId);
 117             return;
 118         }
 119         MountPoint mountPoint = mountPointOpt.get();
 120         final Optional<NotificationService> notificationService = mountPoint.getService(NotificationService.class);
 121         if (notificationService.isEmpty()) {
 122             LOG.error(RPC_SERVICE_FAILED, nodeId);
 123             return;
 124         }
 125         NodeRegistration nodeRegistration =
 126             new NodeRegistration(
 127                 nodeId, openRoadmVersion, notificationService.get(), this.dataBroker, this.portMapping);
 128         nodeRegistration.registerListeners();
 129         registrations.put(nodeId, nodeRegistration);
 130
 131         subscribeStream(mountPoint, nodeId);
 132     }
 133
 134     private void onDeviceDisConnected(final String nodeId) {
 135         LOG.info("onDeviceDisConnected: {}", nodeId);
 136         this.registrations.remove(nodeId).unregisterListeners();
 137     }
 138
 139     private boolean subscribeStream(MountPoint mountPoint, String nodeId) {
 140         final Optional<RpcConsumerRegistry> service = mountPoint.getService(RpcConsumerRegistry.class);
 141         if (service.isEmpty()) {
 142             return false;
 143         }
 144         final NotificationsService rpcService = service.get().getRpcService(NotificationsService.class);
 145         if (rpcService == null) {
 146             LOG.error(RPC_SERVICE_FAILED, nodeId);
 147             return false;
 148         }
 149         // Set the default stream as OPENROADM
 150         for (String streamName : List.of("OPENROADM", "NETCONF")) {
 151             LOG.info("Triggering notification stream {} for node {}", streamName, nodeId);
 152             ListenableFuture<RpcResult<CreateSubscriptionOutput>> subscription =
 153                 rpcService.createSubscription(
 154                     new CreateSubscriptionInputBuilder().setStream(new StreamNameType(streamName)).build());
 155             // If OpenROADM stream is not supported
 156             // Try NETCONF subscription
 157             if (checkSupportedStream(streamName, subscription)) {
 158                 return true;
 159             }
 160         }
 161         return false;
 162     }
 163
 164     @VisibleForTesting
 165     public NetConfTopologyListener(
 166             final NetworkModelService networkModelService,
 167             final DataBroker dataBroker,
 168             DeviceTransactionManager deviceTransactionManager,
 169             PortMapping portMapping,
 170             Map<String, NodeRegistration> registrations) {
 171         this.networkModelService = networkModelService;
 172         this.dataBroker = dataBroker;
 173         this.deviceTransactionManager = deviceTransactionManager;
 174         this.portMapping = portMapping;
 175         this.registrations = registrations;
 176     }
 177
 178     private boolean checkSupportedStream(
 179             String streamName,
 180             ListenableFuture<RpcResult<CreateSubscriptionOutput>> subscription) {
 181         boolean subscriptionSuccessful = false;
 182         try {
 183             // Using if condition does not work, since we need to handle exceptions
 184             subscriptionSuccessful = subscription.get().isSuccessful();
 185             LOG.info("{} subscription is {}", streamName, subscriptionSuccessful);
 186         } catch (InterruptedException | ExecutionException e) {
 187             LOG.error("Error during subscription to stream {}", streamName, e);
 188         }
 189         return subscriptionSuccessful;
 190     }
 191
 192 }