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