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