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      *
  80      * @return node builder status
  81      */
  82     public static Node createNode(String nodeId, DeviceTransactionManager deviceTransactionManager,
  83                                   String openRoadmVersion) {
  84
  85         InfoSubtree infoSubtree = new InfoSubtree(openRoadmVersion);
  86         String clli;
  87         String vendor;
  88         String model;
  89         IpAddress ipAddress;
  90         int nodeType;
  91
  92         if (infoSubtree.getDeviceInfo(nodeId, deviceTransactionManager)) {
  93
  94             clli = infoSubtree.getClli();
  95
  96             /**
  97              * TODO : Uncomment when real when testing on real device
  98              * vendor = infoSubtree.getVendor();
  99              * model = infoSubtree.getModel();
 100              **/
 101             vendor = infoSubtree.getVendor();
 102             clli = infoSubtree.getClli();
 103             model = infoSubtree.getModel();
 104             ipAddress = infoSubtree.getIpAddress();
 105             nodeType = infoSubtree.getNodeType();
 106
 107         } else {
 108             return null;
 109         }
 110
 111         // Uses the Node Builder to set the nodeId and Key
 112         NodeBuilder nodeBldr = new NodeBuilder();
 113         NodeId nwNodeId = new NodeId(nodeId);
 114         nodeBldr.setNodeId(nwNodeId);
 115         nodeBldr.withKey(new NodeKey(nwNodeId));
 116         Node1Builder node1bldr = new Node1Builder();
 117
 118         /*
 119          * Recognize the node type: 1:ROADM, 2:XPONDER
 120          */
 121         switch (nodeType) {
 122             case 1:
 123                 node1bldr.setNodeType(OpenroadmNodeType.ROADM);
 124                 break;
 125             case 2:
 126                 node1bldr.setNodeType(OpenroadmNodeType.XPONDER);
 127                 break;
 128             default:
 129                 LOG.error("No correponsding type for the value: {}", nodeType);
 130                 break;
 131         }
 132
 133
 134         // Sets IP, Model and Vendor information fetched from the deviceInfo
 135         node1bldr.setIp(ipAddress);
 136         node1bldr.setModel(model);
 137         node1bldr.setVendor(vendor);
 138
 139         // Sets the value of Network-ref and Node-ref as a part of the supporting node
 140         // attribute
 141
 142         SupportingNodeBuilder supportbldr = new SupportingNodeBuilder();
 143         supportbldr.withKey(new SupportingNodeKey(new NetworkId(NetworkUtils.CLLI_NETWORK_ID), new NodeId(clli)));
 144         supportbldr.setNetworkRef(new NetworkId(NetworkUtils.CLLI_NETWORK_ID));
 145         supportbldr.setNodeRef(new NodeId(clli));
 146         nodeBldr.setSupportingNode(ImmutableList.of(supportbldr.build()));
 147
 148         // Augment to the main node builder
 149         nodeBldr.addAugmentation(Node1.class, node1bldr.build());
 150         return nodeBldr.build();
 151     }
 152
 153     /**
 154      * Create empty OpenROADM network.
 155      */
 156     private static Network createOpenRoadmNetwork() {
 157         NetworkBuilder openrdmnwBuilder = new NetworkBuilder();
 158         NetworkId nwId = new NetworkId(NetworkUtils.UNDERLAY_NETWORK_ID);
 159         openrdmnwBuilder.setNetworkId(nwId);
 160         openrdmnwBuilder.withKey(new NetworkKey(nwId));
 161         // sets network type to OpenRoadmNetwork
 162         NetworkTypes1Builder openRoadmNetworkTypesBldr = new NetworkTypes1Builder();
 163         openRoadmNetworkTypesBldr.setOpenroadmCommonNetwork(new OpenroadmCommonNetworkBuilder().build());
 164         NetworkTypesBuilder openrdmnwTypeBuilder = new NetworkTypesBuilder();
 165         openrdmnwTypeBuilder.addAugmentation(NetworkTypes1.class, openRoadmNetworkTypesBldr.build());
 166         openrdmnwBuilder.setNetworkTypes(openrdmnwTypeBuilder.build());
 167         return openrdmnwBuilder.build();
 168     }
 169 }