networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmTopology22.java

   1 /*
   2  * Copyright © 2016 AT&T 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
   9 package org.opendaylight.transportpce.networkmodel.util;
  10
  11 import java.util.ArrayList;
  12 import java.util.Collections;
  13 import java.util.List;
  14 import java.util.Optional;
  15 import java.util.concurrent.ExecutionException;
  16 import java.util.concurrent.TimeUnit;
  17 import java.util.concurrent.TimeoutException;
  18
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.transportpce.common.NetworkUtils;
  21 import org.opendaylight.transportpce.common.Timeouts;
  22 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  23 import org.opendaylight.transportpce.common.network.NetworkTransactionService;
  24 import org.opendaylight.transportpce.networkmodel.dto.NodeData;
  25 import org.opendaylight.transportpce.networkmodel.dto.TopologyShard;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.NodeTypes;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev170929.State;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev170929.degree.node.attributes.AvailableWavelengths;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev170929.degree.node.attributes.AvailableWavelengthsBuilder;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.degree.rev170929.degree.node.attributes.AvailableWavelengthsKey;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.Ports;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.pack.PortsKey;
  33 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacks;
  34 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.circuit.packs.CircuitPacksKey;
  35 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.degree.ConnectionPorts;
  36 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.OrgOpenroadmDevice;
  37 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Degree;
  38 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.DegreeKey;
  39 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.Info;
  40 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroup;
  41 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev181019.org.openroadm.device.container.org.openroadm.device.SharedRiskGroupKey;
  42 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.Link1;
  43 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.Link1Builder;
  44 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.NetworkTypes1;
  45 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.NetworkTypes1Builder;
  46 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.Node1;
  47 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.Node1Builder;
  48 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.TerminationPoint1;
  49 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.TerminationPoint1Builder;
  50 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.network.network.types.OpenroadmTopologyBuilder;
  51 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.network.node.DegreeAttributesBuilder;
  52 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.network.node.SrgAttributesBuilder;
  53 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.network.node.termination.point.XpdrClientAttributesBuilder;
  54 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.topology.rev170929.network.node.termination.point.XpdrNetworkAttributesBuilder;
  55 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev170929.OpenroadmLinkType;
  56 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev170929.OpenroadmNodeType;
  57 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev170929.OpenroadmTpType;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.Network;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkBuilder;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkId;
  61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkKey;
  62 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NodeId;
  63 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NetworkTypesBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.Node;
  65 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NodeBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NodeKey;
  67 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.node.SupportingNode;
  68 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.node.SupportingNodeBuilder;
  69 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.node.SupportingNodeKey;
  70 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.LinkId;
  71 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Network1;
  72 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Network1Builder;
  73 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.TpId;
  74 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.Link;
  75 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.LinkBuilder;
  76 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.LinkKey;
  77 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.node.TerminationPoint;
  78 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.node.TerminationPointBuilder;
  79 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.network.node.TerminationPointKey;
  80 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  81 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  82 import org.slf4j.Logger;
  83 import org.slf4j.LoggerFactory;
  84
  85 public class OpenRoadmTopology22 {
  86
  87     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmTopology22.class);
  88     private static final int DEFAULT_PORT_DIRECTION = -1;
  89     private static final int MAX_DEGREE = 20;
  90     private static final int MAX_SRG = 20;
  91
  92     private NetworkTransactionService networkTransactionService;
  93     private final DeviceTransactionManager deviceTransactionManager;
  94
  95     public OpenRoadmTopology22(NetworkTransactionService networkTransactionService,
  96                                DeviceTransactionManager deviceTransactionManager) {
  97         this.networkTransactionService = networkTransactionService;
  98         this.deviceTransactionManager = deviceTransactionManager;
  99     }
 100
 101     /**
 102      * This public method creates the OpenROADM Topology
 103      * Layer and posts it to the controller.
 104      */
 105     public void createTopoLayer() {
 106         try {
 107             Network openRoadmTopology = createOpenRoadmTopology();
 108             InstanceIdentifierBuilder<Network> nwIID = InstanceIdentifier.builder(Network.class,
 109                 new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID)));
 110
 111             this.networkTransactionService.put(LogicalDatastoreType.CONFIGURATION, nwIID.build(), openRoadmTopology);
 112             this.networkTransactionService.submit().get(1, TimeUnit.SECONDS);
 113             LOG.info("OpenRoadm-Topology created successfully.");
 114         } catch (ExecutionException | TimeoutException | InterruptedException e) {
 115             LOG.warn("Failed to create OpenRoadm-Topology", e);
 116         }
 117     }
 118
 119     /**
 120      * Create empty OpenROADM topology.
 121      */
 122     private Network createOpenRoadmTopology() {
 123         NetworkBuilder nwBuilder = new NetworkBuilder();
 124         NetworkId nwId = new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID);
 125         nwBuilder.setNetworkId(nwId);
 126         nwBuilder.withKey(new NetworkKey(nwId));
 127         NetworkTypes1Builder topoNetworkTypesBldr = new NetworkTypes1Builder();
 128         topoNetworkTypesBldr.setOpenroadmTopology(new OpenroadmTopologyBuilder().build());
 129         NetworkTypesBuilder nwTypeBuilder = new NetworkTypesBuilder();
 130         nwTypeBuilder.addAugmentation(NetworkTypes1.class, topoNetworkTypesBldr.build());
 131         nwBuilder.setNetworkTypes(nwTypeBuilder.build());
 132         // Array to store nodes in the topolayer of a roadm/Xponder
 133         Network1Builder nwBldr1 = new Network1Builder();
 134         // adding expressLinks
 135         nwBldr1.setLink(Collections.emptyList());
 136         nwBuilder.addAugmentation(Network1.class, nwBldr1.build());
 137         nwBuilder.setNode(Collections.emptyList());
 138         return nwBuilder.build();
 139     }
 140
 141     public TopologyShard createTopologyShard(String nodeId) {
 142         int numOfDegrees;
 143         int numOfSrgs;
 144         int portDirectionEnum = DEFAULT_PORT_DIRECTION;
 145
 146         InstanceIdentifier<Info> infoIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(Info.class);
 147         java.util.Optional<Info> deviceInfoOpt =
 148                 deviceTransactionManager.getDataFromDevice(nodeId, LogicalDatastoreType.OPERATIONAL, infoIID,
 149                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 150         Info deviceInfo;
 151         if (deviceInfoOpt.isPresent()) {
 152             deviceInfo = deviceInfoOpt.get();
 153         } else {
 154             LOG.error("Unable to get device info for device {}!", nodeId);
 155             return null;
 156         }
 157         List<Node> nodes = new ArrayList<>();
 158         // Check if node is ROADM
 159         if (NodeTypes.Rdm.getName().equals(deviceInfo.getNodeType().getName())) {
 160
 161             /*
 162              * Adding Degree Node Get Degree Number -> x then get connection ports then find the port directions
 163              * to decide whether TX/RX/TXRX Get value for max degree from info subtree, required for iteration
 164              * if not present assume to be 20 (temporary)
 165              */
 166
 167             Integer maxDegree;
 168             if (deviceInfo.getMaxDegrees() != null) {
 169                 maxDegree = deviceInfo.getMaxDegrees();
 170             } else {
 171                 maxDegree = MAX_DEGREE;
 172             }
 173
 174             // Starting with degree Number = 1
 175             Integer degreeCounter = 1;
 176
 177             while (degreeCounter <= maxDegree) {
 178                 LOG.info("creating degree node {}/{}", degreeCounter, maxDegree);
 179                 NodeData nodeData = createDegreeNode(nodeId, degreeCounter);
 180                 if (nodeData != null) {
 181                     NodeBuilder tempNode = nodeData.getNodeBuilder();
 182                     portDirectionEnum = nodeData.getPortDirectionEnum();
 183                     nodes.add(tempNode.build());
 184                     degreeCounter++;
 185                 }
 186                 // null returned if Degree number= degreeCounter not present in the device
 187                 else {
 188                     break;
 189                 }
 190             }
 191             numOfDegrees = degreeCounter - 1;
 192
 193             Integer maxSrg;
 194             if (deviceInfo.getMaxSrgs() != null) {
 195                 maxSrg = deviceInfo.getMaxSrgs();
 196             } else {
 197                 maxSrg = MAX_SRG;
 198             }
 199
 200             // Starting with degree Number = 1
 201             Integer srgCounter = 1;
 202
 203             while (srgCounter <= maxSrg) {
 204                 LOG.info("creating SRG node {}/{}", srgCounter, maxSrg);
 205                 NodeBuilder tempNode = createSrgNode(nodeId, srgCounter, portDirectionEnum);
 206
 207                 if (tempNode != null) {
 208                     nodes.add(tempNode.build());
 209                     srgCounter++;
 210                 } else {
 211                     // null returned if Degree number= degreeCounter not present in the device
 212                     break;
 213                 }
 214             }
 215             numOfSrgs = srgCounter - 1;
 216
 217
 218             LOG.info("adding links numOfDegrees={} numOfSrgs={}", numOfDegrees, numOfSrgs);
 219             List<Link> links = new ArrayList<>();
 220             links.addAll(createExpressLinks(nodeId, numOfDegrees, portDirectionEnum));
 221             links.addAll(createAddDropLinks(nodeId, numOfDegrees, numOfSrgs, portDirectionEnum));
 222             LOG.info("created nodes/links: {}/{}", nodes.size(), links.size());
 223             return new TopologyShard(nodes, links);
 224         } else if (NodeTypes.Xpdr.getName().equals(deviceInfo.getNodeType().getName())) {
 225             // Check if node is XPONDER
 226             Integer clientport = getNoOfClientPorts(nodeId);
 227             List<Link> links = new ArrayList<>();
 228             Integer clientCounter = 1;
 229             Integer lineCounter = 1;
 230             while (clientCounter <= clientport) {
 231                 NodeBuilder tempNode = createXpdr(clientCounter, lineCounter, nodeId);
 232                 if (tempNode == null) {
 233                     break;
 234                 }
 235                 nodes.add(tempNode.build());
 236                 clientCounter++;
 237                 lineCounter++;
 238                 LOG.info("Entered this loop");
 239             }
 240             return new TopologyShard(nodes, links);
 241         }
 242         LOG.error("Device node Type not managed yet");
 243         return null;
 244     }
 245
 246     /**
 247      * This private method gets the list of circuit packs on a xponder. For each circuit pack on a
 248      * Xponder, it does a get on circuit-pack subtree with circuit-pack-name as key in order to get the
 249      * list of ports. It then iterates over the list of ports to get ports with port-qual as
 250      * xpdr-network/xpdr-client. The line and client ports are saved as:
 251      *
 252      * <p>
 253      * 1. LINEn
 254      *
 255      * <p>
 256      * 2. CLNTn
 257      */
 258     private int getNoOfClientPorts(String deviceId) {
 259         // Creating for Xponder Line and Client Ports
 260         InstanceIdentifier<OrgOpenroadmDevice> deviceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class);
 261         Optional<OrgOpenroadmDevice> deviceObject =
 262                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.CONFIGURATION, deviceIID,
 263                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 264
 265         // Variable to keep track of number of client ports
 266         int client = 1;
 267         if (deviceObject.isPresent()) {
 268             for (CircuitPacks cp : deviceObject.get().getCircuitPacks()) {
 269                 if (cp.getPorts() != null) {
 270                     for (Ports port : cp.getPorts()) {
 271                         if (port.getPortQual() != null) {
 272                             if (port.getPortQual().getIntValue() == 4) {
 273                                 client++;
 274                             }
 275                         }
 276                     }
 277                 }
 278             }
 279         } else {
 280             return 0;
 281         }
 282         return client;
 283     }
 284
 285     private NodeBuilder createXpdr(Integer clientCounter, Integer lineCounter, String nodeId) {
 286         // Create a generic Topo Layer node
 287         NodeBuilder nodebldr = createTopoLayerNode(nodeId);
 288         // Create augmentation node to inorder to add degree
 289         Node1Builder node1bldr = new Node1Builder();
 290         TerminationPoint1Builder tp1Bldr = new TerminationPoint1Builder();
 291         TerminationPointBuilder tempTpBldr;
 292
 293         // set node type to Xponder
 294         node1bldr.setNodeType(OpenroadmNodeType.XPONDER);
 295         List<TerminationPoint> tpList = new ArrayList<>();
 296         String nodeIdtopo = new StringBuilder().append(nodeId).append("-XPDR1").toString();
 297         // Ad degree node specific augmentation
 298         nodebldr.setNodeId(new NodeId(nodeIdtopo));
 299         nodebldr.withKey((new NodeKey(new NodeId(nodeIdtopo))));
 300         nodebldr.addAugmentation(Node1.class, node1bldr.build());
 301         while (clientCounter != 0) {
 302             // Create CLNT-TX termination
 303             tempTpBldr = createTpBldr("XPDR1-CLIENT" + clientCounter);
 304             tp1Bldr.setTpType(OpenroadmTpType.XPONDERCLIENT);
 305             XpdrClientAttributesBuilder xpdrClntBldr = new XpdrClientAttributesBuilder();
 306             xpdrClntBldr.setTailEquipmentId("XPDR1-NETWORK" + clientCounter);
 307             tp1Bldr.setXpdrClientAttributes(xpdrClntBldr.build());
 308             tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 309             tpList.add(tempTpBldr.build());
 310             clientCounter--; }
 311         while (lineCounter != 0) {
 312             // Create LINE-TX termination
 313             tempTpBldr = (createTpBldr("XPDR1-NETWORK" + lineCounter));
 314             tp1Bldr.setTpType(OpenroadmTpType.XPONDERNETWORK);
 315             XpdrNetworkAttributesBuilder xpdrNwAttrBldr = new XpdrNetworkAttributesBuilder();
 316             xpdrNwAttrBldr.setTailEquipmentId("XPDR1-CLIENT" + lineCounter);
 317             tp1Bldr.setXpdrNetworkAttributes(xpdrNwAttrBldr.build());
 318             tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 319             tpList.add(tempTpBldr.build());
 320             lineCounter--; }
 321         LOG.info("printing tpList {}",tpList);
 322         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608
 323                 .Node1Builder tpNode1 = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang
 324                 .ietf.network.topology.rev150608.Node1Builder();
 325         tpNode1.setTerminationPoint(tpList);
 326         nodebldr.addAugmentation(
 327                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1.class,
 328                 tpNode1.build());
 329         LOG.info("The nodebldr {}",nodebldr);
 330         return nodebldr;
 331     }
 332
 333
 334     private NodeData createDegreeNode(String nodeId, int degreeCounter) {
 335         // Create augmentation node to inorder to add degree
 336         Node1Builder node1bldr = new Node1Builder();
 337         // set node type to degree
 338         node1bldr.setNodeType(OpenroadmNodeType.DEGREE);
 339
 340         // Get connection ports on degree number = degreeCounter in order to get port
 341         // direction
 342         List<ConnectionPorts> degreeConPorts = getDegreePorts(nodeId, degreeCounter);
 343         if (degreeConPorts == null || degreeConPorts.isEmpty()) {
 344             return null;
 345         }
 346
 347         DegreeAttributesBuilder degAttBldr = new DegreeAttributesBuilder();
 348         degAttBldr.setDegreeNumber(degreeCounter);
 349         degAttBldr.setAvailableWavelengths(create96AvalWaveDegree());
 350         node1bldr.setDegreeAttributes(degAttBldr.build());
 351
 352         String nodeIdtopo = new StringBuilder(nodeId).append("-DEG").append(degreeCounter).toString();
 353         // Create a generic Topo Layer node
 354         NodeBuilder nodebldr = createTopoLayerNode(nodeId);
 355         nodebldr.setNodeId(new NodeId(nodeIdtopo));
 356         // Ad degree node specific augmentation
 357         nodebldr.addAugmentation(Node1.class, node1bldr.build());
 358         // Get Port direction
 359         int portDirectionEnum = getPortDirection(nodeId, degreeConPorts.get(0).getCircuitPackName(),
 360                 degreeConPorts.get(0).getPortName().toString());
 361
 362         /*
 363          * if bi-directional then create 2 tp's :
 364          *
 365          * --> TTP-TXRX --> CTP-TXRX
 366          *
 367          * if uni-directional :
 368          *
 369          *     --> TTP-TX
 370          *     --> TTP-RX
 371          *     --> CTP-TX
 372          *     --> CTP-RX
 373          */
 374         TerminationPoint1Builder tp1Bldr = new TerminationPoint1Builder();
 375         TerminationPointBuilder tempTpBldr;
 376
 377         List<TerminationPoint> tpList = new ArrayList<>();
 378         if (portDirectionEnum == 1 || portDirectionEnum == 2) {
 379             // ports are uni Directional on a degree, therefore 4 termination points
 380             // Create TTP-TX termination
 381
 382             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-TTP-TX");
 383             tp1Bldr.setTpType(OpenroadmTpType.DEGREETXTTP);
 384             tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 385             tpList.add(tempTpBldr.build());
 386
 387             // Create TTP-RX termination
 388             tp1Bldr = new TerminationPoint1Builder();
 389             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-TTP-RX");
 390             tp1Bldr.setTpType(OpenroadmTpType.DEGREERXTTP);
 391
 392             tempTpBldr.addAugmentation(TerminationPoint1.class,tp1Bldr.build());
 393             tpList.add(tempTpBldr.build());
 394
 395             // Create CTP-TX termination
 396             tp1Bldr = new TerminationPoint1Builder();
 397             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-CTP-TX");
 398             tp1Bldr.setTpType(OpenroadmTpType.DEGREETXCTP);
 399             tempTpBldr.addAugmentation(TerminationPoint1.class,tp1Bldr.build());
 400             tpList.add(tempTpBldr.build());
 401
 402             // Create CTP-RX termination
 403             tp1Bldr = new TerminationPoint1Builder();
 404             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-CTP-RX");
 405             tp1Bldr.setTpType(OpenroadmTpType.DEGREERXCTP);
 406             tempTpBldr.addAugmentation(TerminationPoint1.class,tp1Bldr.build());
 407             tpList.add(tempTpBldr.build());
 408
 409         } else if (portDirectionEnum == 3) {
 410             // Ports are bi directional therefore 2 termination points
 411             // Create TTP-TXRX termination
 412             tp1Bldr = new TerminationPoint1Builder();
 413             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-TTP-TXRX");
 414             tp1Bldr.setTpType(OpenroadmTpType.DEGREETXRXTTP);
 415             tempTpBldr.addAugmentation(TerminationPoint1.class,tp1Bldr.build());
 416             tpList.add(tempTpBldr.build());
 417
 418             // Create CTP-TXRX termination
 419             tp1Bldr = new TerminationPoint1Builder();
 420             tempTpBldr = createTpBldr("DEG" + degreeCounter + "-CTP-TXRX");
 421             tp1Bldr.setTpType(OpenroadmTpType.DEGREETXRXCTP);
 422             tempTpBldr.addAugmentation(TerminationPoint1.class,tp1Bldr.build());
 423             tpList.add(tempTpBldr.build());
 424
 425         }
 426
 427         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1Builder tpNode1
 428                 = new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology
 429                 .rev150608.Node1Builder();
 430
 431         tpNode1.setTerminationPoint(tpList);
 432
 433         nodebldr.addAugmentation(
 434                 org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1.class,
 435                 tpNode1.build());
 436         return new NodeData(nodebldr, portDirectionEnum);
 437     }
 438
 439
 440     private NodeBuilder createSrgNode(String nodeId, int srgCounter, int portDirectionEnum) {
 441         // Create augmentation node to in order to add srg
 442         Node1Builder node1bldr = new Node1Builder();
 443         // set node type to SRG
 444         node1bldr.setNodeType(OpenroadmNodeType.SRG);
 445
 446         node1bldr.setNodeType(OpenroadmNodeType.SRG);
 447
 448         SrgAttributesBuilder srgAttrBldr = new SrgAttributesBuilder();
 449         srgAttrBldr.setAvailableWavelengths(create96AvalWaveSrg());
 450         node1bldr.setSrgAttributes(srgAttrBldr.build());
 451         // Create a generic Topo Layer node
 452         NodeBuilder nodebldr = createTopoLayerNode(nodeId);
 453         nodebldr.addAugmentation(Node1.class, node1bldr.build());
 454
 455
 456         // Get connection ports on degree number = degreeCounter in order to get port
 457         // direction
 458         int maxPpPorts = getMaxPp(nodeId, srgCounter);
 459         if (maxPpPorts == -1) {
 460             return null;
 461         }
 462
 463
 464         String nodeIdtopo = new StringBuilder().append(nodeId).append("-SRG").append(srgCounter).toString();
 465         nodebldr.setNodeId(new NodeId(nodeIdtopo));
 466         List<TerminationPoint> tpList = new ArrayList<>();
 467
 468         TerminationPoint1Builder tp1Bldr;
 469         TerminationPointBuilder tempTpBldr;
 470
 471         for (int i = 1; i <= maxPpPorts; i++) {
 472             if (portDirectionEnum == 1 || portDirectionEnum == 2) {
 473                 if (i >= maxPpPorts / 2) {
 474                     break;
 475                 }
 476                 // ports are uni Directional on a degree, therefore 4 termination points
 477                 // Create PP-TX termination
 478                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-PP" + i + "-TX");
 479                 tp1Bldr = new TerminationPoint1Builder();
 480                 tp1Bldr.setTpType(OpenroadmTpType.SRGTXPP);
 481                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 482                 tpList.add(tempTpBldr.build());
 483
 484                 // Create PP-RX termination
 485                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-PP" + i + "-RX");
 486                 tp1Bldr = new TerminationPoint1Builder();
 487                 tp1Bldr.setTpType(OpenroadmTpType.SRGRXPP);
 488                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 489                 tpList.add(tempTpBldr.build());
 490
 491             } else if (portDirectionEnum == 3) {
 492                 // Ports are bi directional therefore 2 termination points
 493                 // Create PP-TXRX termination
 494                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-PP" + i + "-TXRX");
 495                 tp1Bldr = new TerminationPoint1Builder();
 496                 tp1Bldr.setTpType(OpenroadmTpType.SRGTXRXPP);
 497                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 498                 tpList.add(tempTpBldr.build());
 499             }
 500         }
 501
 502         switch (portDirectionEnum) {
 503             case 1: // ports are uni Directional on a degree
 504             case 2:
 505                 // Create CP-TX termination
 506                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-CP" + "-TX");
 507                 tp1Bldr = new TerminationPoint1Builder();
 508                 tp1Bldr.setTpType(OpenroadmTpType.SRGTXCP);
 509                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 510                 tpList.add(tempTpBldr.build());
 511                 // Create CP-RX termination
 512                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-CP" + "-RX");
 513                 tp1Bldr = new TerminationPoint1Builder();
 514                 tp1Bldr.setTpType(OpenroadmTpType.SRGRXCP);
 515                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 516                 tpList.add(tempTpBldr.build());
 517                 break;
 518             case 3:
 519                 // Ports are bi directional therefore 2 termination points
 520                 // Create CP-TXRX termination
 521                 tempTpBldr = createTpBldr("SRG" + srgCounter + "-CP" + "-TXRX");
 522                 tp1Bldr = new TerminationPoint1Builder();
 523                 tp1Bldr.setTpType(OpenroadmTpType.SRGTXRXCP);
 524                 tempTpBldr.addAugmentation(TerminationPoint1.class, tp1Bldr.build());
 525                 tpList.add(tempTpBldr.build());
 526                 break;
 527             default:
 528                 LOG.error("No correponsding direction to the value: {}", portDirectionEnum);
 529                 break;
 530         }
 531
 532         org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1Builder tpNode1 =
 533             new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1Builder();
 534
 535         tpNode1.setTerminationPoint(tpList);
 536
 537         nodebldr.addAugmentation(
 538             org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.topology.rev150608.Node1.class,
 539             tpNode1.build());
 540
 541         return nodebldr;
 542     }
 543
 544     /*
 545      * This method will return the TTP ports in the device for a given degree number to be used by the
 546      * node to create TTP and CTP termination point on the device
 547      */
 548     private List<ConnectionPorts> getDegreePorts(String deviceId, Integer degreeCounter) {
 549         List<ConnectionPorts> degreeConPorts = new ArrayList<>();
 550         LOG.info("Getting Connection ports for Degree Number {}", degreeCounter);
 551         InstanceIdentifier<Degree> deviceIID =
 552                 InstanceIdentifier.create(OrgOpenroadmDevice.class).child(Degree.class, new DegreeKey(degreeCounter));
 553
 554         Optional<Degree> ordmDegreeObject =
 555                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.CONFIGURATION, deviceIID,
 556                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 557
 558         if (ordmDegreeObject.isPresent()) {
 559             degreeConPorts.addAll(new ArrayList<>(ordmDegreeObject.get().getConnectionPorts()));
 560         } else {
 561             LOG.info("Device has {} degree", (degreeCounter - 1));
 562             return Collections.emptyList();
 563         }
 564         return degreeConPorts;
 565     }
 566
 567     private int getMaxPp(String deviceId, Integer srgCounter) {
 568         int maxPpPorts;
 569         LOG.info("Getting max pp ports for Srg Number {}", srgCounter);
 570         InstanceIdentifier<SharedRiskGroup> deviceIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 571                 .child(SharedRiskGroup.class, new SharedRiskGroupKey(srgCounter));
 572         Optional<SharedRiskGroup> ordmSrgObject =
 573                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.OPERATIONAL, deviceIID,
 574                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 575         if (ordmSrgObject.isPresent()) {
 576             if (ordmSrgObject.get().getMaxAddDropPorts() != null) {
 577                 maxPpPorts = ordmSrgObject.get().getMaxAddDropPorts();
 578             } else {
 579                 LOG.info("Max add drop ports absent");
 580                 return -1;
 581             }
 582         } else {
 583             LOG.info("SRG  absent");
 584             return -1;
 585         }
 586         return maxPpPorts;
 587     }
 588
 589     private NodeBuilder createTopoLayerNode(String nodeId) {
 590         // Sets the value of Network-ref and Node-ref as a part of the supporting node
 591         // attribute
 592         SupportingNodeBuilder supportbldr = new SupportingNodeBuilder();
 593         supportbldr.withKey(new SupportingNodeKey(new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID), new NodeId(nodeId)));
 594         supportbldr.setNetworkRef(new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID));
 595         supportbldr.setNodeRef(new NodeId(nodeId));
 596         ArrayList<SupportingNode> supportlist = new ArrayList<>();
 597         supportlist.add(supportbldr.build());
 598         NodeBuilder nodebldr = new NodeBuilder();
 599         nodebldr.setSupportingNode(supportlist);
 600         return nodebldr;
 601     }
 602
 603     // Return 0 for null/error values
 604     // Return 1 for tx
 605     // Return 2 for rx
 606     // Return 3 for bi-directional
 607
 608     private int getPortDirection(String deviceId, String circuitPackName, String portName) {
 609         InstanceIdentifier<Ports> portIID = InstanceIdentifier.create(OrgOpenroadmDevice.class)
 610                 .child(CircuitPacks.class, new CircuitPacksKey(circuitPackName))
 611                 .child(Ports.class, new PortsKey(portName));
 612         LOG.info("Fetching Port Direction for port {} at circuit pack {}", portName, circuitPackName);
 613         Optional<Ports> portObject =
 614                 deviceTransactionManager.getDataFromDevice(deviceId, LogicalDatastoreType.OPERATIONAL, portIID,
 615                         Timeouts.DEVICE_READ_TIMEOUT, Timeouts.DEVICE_READ_TIMEOUT_UNIT);
 616         if (portObject.isPresent()) {
 617             Ports port = portObject.get();
 618             if (port.getPortDirection() != null) {
 619                 return port.getPortDirection().getIntValue();
 620             } else {
 621                 LOG.warn("Port direction value missing for {} {}", circuitPackName, port.getPortName());
 622                 return 0;
 623             }
 624         }
 625         return 0;
 626     }
 627
 628     // This method returns a generic termination point builder for a given tpid
 629     private TerminationPointBuilder createTpBldr(String tpId) {
 630         TerminationPointBuilder tpBldr = new TerminationPointBuilder();
 631         TpId tp = new TpId(tpId);
 632         TerminationPointKey tpKey = new TerminationPointKey(tp);
 633         tpBldr.withKey(tpKey);
 634         tpBldr.setTpId(tp);
 635         return tpBldr;
 636     }
 637
 638
 639
 640
 641
 642     private List<Link> createExpressLinks(String nodeId, int numOfDegrees, int portDirectionEnum) {
 643         LOG.info("creating express links {} {} {}", nodeId, numOfDegrees, portDirectionEnum);
 644         List<Link> links = new ArrayList<>();
 645
 646         String srcNode;
 647         String destNode;
 648
 649         String srcTp;
 650         String destTp;
 651
 652         // ports are uni-directional
 653         if (portDirectionEnum == 1 || portDirectionEnum == 2) {
 654             LOG.info("creating uni-directional express links");
 655             for (int i = 1; i <= numOfDegrees; i++) {
 656                 for (int j = i + 1; j <= numOfDegrees; j++) {
 657
 658                     srcNode = nodeId + "-DEG" + i;
 659                     destNode = nodeId + "-DEG" + j;
 660
 661                     // AtoZ direction
 662                     srcTp = "DEG" + i + "-CTP-TX";
 663                     destTp = "DEG" + j + "-CTP-RX";
 664
 665                     LinkBuilder expLinkBldr = TopologyUtils.createLink(srcNode, destNode, srcTp, destTp);
 666
 667                     Link1Builder lnk1Bldr = new Link1Builder();
 668                     lnk1Bldr.setLinkType(OpenroadmLinkType.EXPRESSLINK);
 669                     expLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 670                     links.add(expLinkBldr.build());
 671
 672                     // ZtoA direction
 673                     srcTp = "DEG" + i + "-CTP-RX";
 674                     destTp = "DEG" + j + "-CTP-TX";
 675
 676                     expLinkBldr = TopologyUtils.createLink(destNode, srcNode, destTp, srcTp);
 677                     expLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 678
 679                     links.add(expLinkBldr.build());
 680
 681                 }
 682             }
 683         }
 684
 685         // ports are bi-directional
 686         if (portDirectionEnum == 3) {
 687             LOG.info("creating bi-directional express links");
 688             for (int i = 1; i <= numOfDegrees; i++) {
 689                 for (int j = i + 1; j <= numOfDegrees; j++) {
 690
 691                     srcNode = nodeId + "-DEG" + i;
 692                     destNode = nodeId + "-DEG" + j;
 693
 694                     // AtoZ direction
 695                     srcTp = "DEG" + i + "-CTP-TXRX";
 696                     destTp = "DEG" + j + "-CTP-TXRX";
 697
 698                     Link1Builder lnk1Bldr = new Link1Builder();
 699                     lnk1Bldr.setLinkType(OpenroadmLinkType.EXPRESSLINK);
 700                     LinkBuilder expLinkBldr = TopologyUtils.createLink(srcNode, destNode, srcTp, destTp);
 701                     expLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 702                     links.add(expLinkBldr.build());
 703
 704                     // ZtoA direction
 705                     expLinkBldr = TopologyUtils.createLink(destNode, srcNode, destTp, srcTp);
 706                     expLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 707                     links.add(expLinkBldr.build());
 708                 }
 709             }
 710         }
 711         return links;
 712     }
 713
 714     private List<Link> createAddDropLinks(String nodeId, int numOfDegrees, int numOfSrgs, int portDirectionEnum) {
 715         LOG.info("creating add-drop links {} {} {} {}", nodeId, numOfDegrees, numOfSrgs, portDirectionEnum);
 716         List<Link> links = new ArrayList<>();
 717
 718         String srcNode;
 719         String destNode;
 720
 721         String srcTp;
 722         String destTp;
 723
 724         // ports are uni-directional
 725         if (portDirectionEnum == 1 || portDirectionEnum == 2) {
 726             LOG.info("creating uni-directional add-drop links");
 727             for (int i = 1; i <= numOfDegrees; i++) {
 728                 for (int j = 1; j <= numOfSrgs; j++) {
 729
 730                     srcNode = nodeId + "-DEG" + i;
 731                     destNode = nodeId + "-SRG" + j;
 732
 733                     // drop links
 734                     srcTp = "DEG" + i + "-CTP-TX";
 735                     destTp = "SRG" + j + "-CP-RX";
 736
 737                     LinkBuilder addDropLinkBldr = TopologyUtils.createLink(srcNode, destNode, srcTp, destTp);
 738                     Link1Builder lnk1Bldr = new Link1Builder();
 739                     lnk1Bldr.setLinkType(OpenroadmLinkType.DROPLINK);
 740                     addDropLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 741                     links.add(addDropLinkBldr.build());
 742
 743                     // add links direction
 744                     srcTp = "DEG" + i + "-CTP-RX";
 745                     destTp = "SRG" + j + "-CP-TX";
 746
 747                     addDropLinkBldr = TopologyUtils.createLink(destNode, srcNode, destTp, srcTp);
 748                     lnk1Bldr.setLinkType(OpenroadmLinkType.ADDLINK);
 749                     addDropLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 750                     links.add(addDropLinkBldr.build());
 751
 752                 }
 753             }
 754         }
 755         // ports are bi-directional
 756         if (portDirectionEnum == 3) {
 757             LOG.info("creating bi-directional add-drop links");
 758             for (int i = 1; i <= numOfDegrees; i++) {
 759                 for (int j = 1; j <= numOfSrgs; j++) {
 760
 761                     srcNode = nodeId + "-DEG" + i;
 762                     destNode = nodeId + "-SRG" + j;
 763
 764                     // drop links
 765                     srcTp = "DEG" + i + "-CTP-TXRX";
 766                     destTp = "SRG" + j + "-CP-TXRX";
 767
 768                     LinkBuilder addDropLinkBldr = TopologyUtils.createLink(srcNode, destNode, srcTp, destTp);
 769                     Link1Builder lnk1Bldr = new Link1Builder();
 770                     lnk1Bldr.setLinkType(OpenroadmLinkType.DROPLINK);
 771                     addDropLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 772                     links.add(addDropLinkBldr.build());
 773
 774                     // add link
 775                     addDropLinkBldr = TopologyUtils.createLink(destNode, srcNode, destTp, srcTp);
 776                     lnk1Bldr.setLinkType(OpenroadmLinkType.ADDLINK);
 777                     addDropLinkBldr.addAugmentation(Link1.class, lnk1Bldr.build());
 778                     links.add(addDropLinkBldr.build());
 779                 }
 780             }
 781         }
 782         return links;
 783     }
 784
 785     // This method returns the linkBuilder object for given source and destination
 786     public static boolean deleteLink(String srcNode, String dstNode, String srcTp, String destTp,
 787                                      NetworkTransactionService networkTransactionService) {
 788         LOG.info("deleting link for {}-{}", srcNode, dstNode);
 789         LinkId linkId = LinkIdUtil.buildLinkId(srcNode, srcTp, dstNode, destTp);
 790         if (deleteLinkLinkId(linkId, networkTransactionService)) {
 791             LOG.debug("Link Id {} updated to have admin state down");
 792             return true;
 793         } else {
 794             LOG.debug("Link Id not found for Source {} and Dest {}", srcNode, dstNode);
 795             return false;
 796         }
 797     }
 798
 799     // This method returns the linkBuilder object for given source and destination
 800     public static boolean deleteLinkLinkId(LinkId linkId , NetworkTransactionService networkTransactionService) {
 801         LOG.info("deleting link for LinkId: {}", linkId);
 802         try {
 803             InstanceIdentifierBuilder<Link> linkIID = InstanceIdentifier.builder(Network.class,
 804                 new NetworkKey(new NetworkId(NetworkUtils.OVERLAY_NETWORK_ID))).augmentation(Network1.class)
 805                 .child(Link.class, new LinkKey(linkId));
 806             com.google.common.base.Optional<Link> link =
 807                     networkTransactionService.read(LogicalDatastoreType.CONFIGURATION,linkIID.build()).get();
 808             if (link.isPresent()) {
 809                 LinkBuilder linkBuilder = new LinkBuilder(link.get());
 810                 Link1Builder link1Builder = new Link1Builder(linkBuilder.augmentation(org.opendaylight
 811                         .yang.gen.v1.http.org.openroadm.network.topology.rev170929.Link1.class));
 812                 link1Builder.setAdministrativeState(State.OutOfService);
 813                 linkBuilder.removeAugmentation(Link1.class);
 814                 linkBuilder.addAugmentation(Link1.class,link1Builder.build());
 815                 networkTransactionService.merge(LogicalDatastoreType.CONFIGURATION, linkIID.build(),
 816                         linkBuilder.build());
 817                 networkTransactionService.submit().get(1, TimeUnit.SECONDS);
 818                 return true;
 819             } else {
 820                 LOG.error("No link found for given LinkId: {}",
 821                         linkId);
 822                 return false;
 823             }
 824
 825         } catch (InterruptedException | ExecutionException | TimeoutException e) {
 826             LOG.error(e.getMessage(), e);
 827             return false;
 828         }
 829     }
 830
 831     private List<AvailableWavelengths> create96AvalWaveDegree() {
 832         List<AvailableWavelengths> waveList = new ArrayList<>();
 833
 834         for (int i = 1; i < 97; i++) {
 835             AvailableWavelengthsBuilder avalBldr = new AvailableWavelengthsBuilder();
 836             avalBldr.setIndex((long) i);
 837             avalBldr.withKey(new AvailableWavelengthsKey((long) i));
 838             waveList.add(avalBldr.build());
 839         }
 840
 841         return waveList;
 842     }
 843
 844     private List<org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev170929.srg.node
 845             .attributes.AvailableWavelengths> create96AvalWaveSrg() {
 846
 847         List<org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev170929.srg.node.attributes
 848                 .AvailableWavelengths> waveList =
 849                 new ArrayList<>();
 850
 851         for (int i = 1; i < 97; i++) {
 852             org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev170929.srg.node.attributes
 853                     .AvailableWavelengthsBuilder avalBldr =
 854                     new org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev170929.srg.node
 855                             .attributes.AvailableWavelengthsBuilder();
 856             avalBldr.setIndex((long) i);
 857             avalBldr.withKey(
 858                     new org.opendaylight.yang.gen.v1.http.org.openroadm.srg.rev170929.srg.node
 859                             .attributes.AvailableWavelengthsKey(
 860                             (long) i));
 861             waveList.add(avalBldr.build());
 862         }
 863
 864         return waveList;
 865     }
 866 }