networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/OpenRoadmNetwork.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 com.google.common.collect.ImmutableList;
  12
  13 import java.util.Optional;
  14 import java.util.concurrent.ExecutionException;
  15 import java.util.concurrent.TimeUnit;
  16 import java.util.concurrent.TimeoutException;
  17
  18 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  19 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  20 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  21 import org.opendaylight.transportpce.common.NetworkUtils;
  22 import org.opendaylight.transportpce.common.Timeouts;
  23 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  24 import org.opendaylight.yang.gen.v1.http.org.openroadm.common.types.rev161014.NodeTypes;
  25 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.OrgOpenroadmDevice;
  26 import org.opendaylight.yang.gen.v1.http.org.openroadm.device.rev170206.org.openroadm.device.container.org.openroadm.device.Info;
  27 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.rev170929.NetworkTypes1;
  28 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.rev170929.NetworkTypes1Builder;
  29 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.rev170929.Node1;
  30 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.rev170929.Node1Builder;
  31 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.rev170929.network.network.types.OpenroadmNetworkBuilder;
  32 import org.opendaylight.yang.gen.v1.http.org.openroadm.network.types.rev170929.OpenroadmNodeType;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.Network;
  35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkId;
  37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NetworkKey;
  38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.NodeId;
  39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NetworkTypesBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.Node;
  41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NodeBuilder;
  42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.NodeKey;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.node.SupportingNodeBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev150608.network.node.SupportingNodeKey;
  45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  46 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public class OpenRoadmNetwork {
  51
  52     private static final Logger LOG = LoggerFactory.getLogger(OpenRoadmNetwork.class);
  53
  54     private OpenRoadmNetwork() {
  55         // utility class
  56     }
  57
  58     /**
  59      * This public method creates the OpenRoadmNetwork Layer and posts it to the
  60      * controller.
  61      */
  62     public static void createOpenRoadmNetworkLayer(DataBroker controllerdb) {
  63         try {
  64             Network openRoadmNetwork = createOpenRoadmNetwork();
  65             InstanceIdentifierBuilder<Network> nwIID = InstanceIdentifier.builder(Network.class,
  66                     new NetworkKey(new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID)));
  67             WriteTransaction wrtx = controllerdb.newWriteOnlyTransaction();
  68             wrtx.put(LogicalDatastoreType.CONFIGURATION, nwIID.build(), openRoadmNetwork);
  69             wrtx.submit().get(1, TimeUnit.SECONDS);
  70             LOG.info("OpenRoadm-Network created successfully.");
  71         } catch (ExecutionException | TimeoutException | InterruptedException e) {
  72             LOG.warn("Failed to create OpenRoadm-Network", e);
  73         }
  74     }
  75
  76     /**
  77      * Create single node entry for OpenRoadmNetwork.
  78      *
  79      */
  80     public static Node createNode(String nodeId, DeviceTransactionManager deviceTransactionManager) {
  81         // Fetches the info from the deviceInfo
  82         InstanceIdentifier<Info> infoIID = InstanceIdentifier.create(OrgOpenroadmDevice.class).child(Info.class);
  83         Optional<Info> deviceInfoOpt = deviceTransactionManager.getDataFromDevice(nodeId,
  84                 LogicalDatastoreType.OPERATIONAL, infoIID, Timeouts.DEVICE_READ_TIMEOUT,
  85                 Timeouts.DEVICE_READ_TIMEOUT_UNIT);
  86         Info deviceInfo;
  87         if (deviceInfoOpt.isPresent()) {
  88             deviceInfo = deviceInfoOpt.get();
  89         } else {
  90             LOG.error("Unable to get device info from device {}!", nodeId);
  91             return null;
  92         }
  93         NodeTypes nodeType = deviceInfo.getNodeType();
  94
  95         // Uses the Node Builder to set the nodeId and Key
  96         NodeBuilder nodeBldr = new NodeBuilder();
  97         NodeId nwNodeId = new NodeId(nodeId);
  98         nodeBldr.setNodeId(nwNodeId);
  99         nodeBldr.setKey(new NodeKey(nwNodeId));
 100         Node1Builder node1bldr = new Node1Builder();
 101
 102         /*
 103          * Recognize the node type: 1:ROADM, 2:XPONDER
 104          */
 105         switch (nodeType.getIntValue()) {
 106             case 1:
 107                 node1bldr.setNodeType(OpenroadmNodeType.ROADM);
 108                 break;
 109             case 2:
 110                 node1bldr.setNodeType(OpenroadmNodeType.XPONDER);
 111                 break;
 112             default:
 113                 LOG.error("No correponsding type for the value: {}", nodeType.getIntValue());
 114                 break;
 115         }
 116
 117         String vendor = deviceInfo.getVendor();
 118         String model = deviceInfo.getModel();
 119         IpAddress ipAddress = deviceInfo.getIpAddress();
 120         // Sets IP, Model and Vendor information fetched from the deviceInfo
 121         node1bldr.setIp(ipAddress);
 122         node1bldr.setModel(model);
 123         node1bldr.setVendor(vendor);
 124
 125         // Sets the value of Network-ref and Node-ref as a part of the supporting node
 126         // attribute
 127         String clli = deviceInfo.getClli();
 128         SupportingNodeBuilder supportbldr = new SupportingNodeBuilder();
 129         supportbldr.setKey(new SupportingNodeKey(new NetworkId(NetworkUtils.CLLI_NETWORK_ID), new NodeId(clli)));
 130         supportbldr.setNetworkRef(new NetworkId(NetworkUtils.CLLI_NETWORK_ID));
 131         supportbldr.setNodeRef(new NodeId(clli));
 132         nodeBldr.setSupportingNode(ImmutableList.of(supportbldr.build()));
 133
 134         // Augment to the main node builder
 135         nodeBldr.addAugmentation(Node1.class, node1bldr.build());
 136         return nodeBldr.build();
 137     }
 138
 139     /**
 140      * Create empty OpenROADM network.
 141      */
 142     private static Network createOpenRoadmNetwork() {
 143         NetworkBuilder openrdmnwBuilder = new NetworkBuilder();
 144         NetworkId nwId = new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID);
 145         openrdmnwBuilder.setNetworkId(nwId);
 146         openrdmnwBuilder.setKey(new NetworkKey(nwId));
 147         // sets network type to OpenRoadmNetwork
 148         NetworkTypes1Builder openRoadmNetworkTypesBldr = new NetworkTypes1Builder();
 149         openRoadmNetworkTypesBldr.setOpenroadmNetwork(new OpenroadmNetworkBuilder().build());
 150         NetworkTypesBuilder openrdmnwTypeBuilder = new NetworkTypesBuilder();
 151         openrdmnwTypeBuilder.addAugmentation(NetworkTypes1.class, openRoadmNetworkTypesBldr.build());
 152         openrdmnwBuilder.setNetworkTypes(openrdmnwTypeBuilder.build());
 153         return openrdmnwBuilder.build();
 154     }
 155 }