networkmodel/src/main/java/org/opendaylight/transportpce/networkmodel/util/ClliNetwork.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.concurrent.ExecutionException;
  12 import java.util.concurrent.TimeUnit;
  13 import java.util.concurrent.TimeoutException;
  14 import org.opendaylight.mdsal.binding.api.DataBroker;
  15 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  16 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  17 import org.opendaylight.transportpce.common.NetworkUtils;
  18 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev200113.network.nodes.NodeInfo;
  19 import org.opendaylight.yang.gen.v1.http.org.openroadm.clli.network.rev181130.NetworkTypes1;
  20 import org.opendaylight.yang.gen.v1.http.org.openroadm.clli.network.rev181130.NetworkTypes1Builder;
  21 import org.opendaylight.yang.gen.v1.http.org.openroadm.clli.network.rev181130.Node1;
  22 import org.opendaylight.yang.gen.v1.http.org.openroadm.clli.network.rev181130.Node1Builder;
  23 import org.opendaylight.yang.gen.v1.http.org.openroadm.clli.network.rev181130.networks.network.network.types.ClliNetworkBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NetworkId;
  25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.Networks;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.NodeId;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.Network;
  28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.NetworkKey;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NetworkTypesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.Node;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.network.rev180226.networks.network.NodeKey;
  34 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public final class ClliNetwork {
  40
  41     private static final Logger LOG = LoggerFactory.getLogger(ClliNetwork.class);
  42
  43     private ClliNetwork() {
  44         // utility class
  45     }
  46
  47     /**
  48      * This public method creates the CLLI Layer and posts it to the controller.
  49      *
  50      * @param controllerdb   controller Databroker
  51      */
  52     public static void createClliLayer(DataBroker controllerdb) {
  53         try {
  54             Network clliNetwork = createNetwork();
  55             InstanceIdentifierBuilder<Network> nwIID = InstanceIdentifier.builder(Networks.class).child(Network.class,
  56                 new NetworkKey(new NetworkId(NetworkUtils.CLLI_NETWORK_ID)));
  57             WriteTransaction wrtx = controllerdb.newWriteOnlyTransaction();
  58             wrtx.put(LogicalDatastoreType.CONFIGURATION, nwIID.build(), clliNetwork);
  59             wrtx.commit().get(1, TimeUnit.SECONDS);
  60             LOG.info("CLLI-Network created successfully.");
  61         } catch (ExecutionException | TimeoutException | InterruptedException e) {
  62             LOG.warn("Failed to create CLLI-Network", e);
  63         }
  64     }
  65
  66     /**
  67      * Create single node entry for CLLI topology.
  68      *
  69      * @param deviceId device ID
  70      * @param nodeInfo Some important and general data from device
  71      *
  72      * @return node builder status
  73      */
  74     public static Node createNode(String deviceId, NodeInfo nodeInfo) {
  75         String clli = nodeInfo.getNodeClli();
  76         /*
  77          * Create node in the CLLI layer of the network model
  78          * with nodeId equal to the clli attribute in the device
  79          * model's info subtree
  80          */
  81         NodeBuilder nodeBldr = new NodeBuilder();
  82         NodeId nwNodeId = new NodeId(clli);
  83         nodeBldr.setNodeId(nwNodeId);
  84         nodeBldr.withKey(new NodeKey(nwNodeId));
  85         /*
  86          * create clli node augmentation
  87          * defined in openroadm-clli-network.yang
  88          */
  89         Node1Builder clliAugmentationBldr = new Node1Builder();
  90         clliAugmentationBldr.setClli(clli);
  91         nodeBldr.addAugmentation(Node1.class, clliAugmentationBldr.build());
  92         return nodeBldr.build();
  93     }
  94
  95     /**
  96      * Create empty CLLI network.
  97      */
  98     private static Network createNetwork() {
  99         NetworkBuilder nwBuilder = new NetworkBuilder();
 100         NetworkId nwId = new NetworkId(NetworkUtils.CLLI_NETWORK_ID);
 101         nwBuilder.setNetworkId(nwId);
 102         nwBuilder.withKey(new NetworkKey(nwId));
 103         //set network type to clli
 104         NetworkTypes1Builder clliNetworkTypesBldr = new NetworkTypes1Builder();
 105         clliNetworkTypesBldr.setClliNetwork(new ClliNetworkBuilder().build());
 106         NetworkTypesBuilder nwTypeBuilder = new NetworkTypesBuilder();
 107         nwTypeBuilder.addAugmentation(NetworkTypes1.class, clliNetworkTypesBldr.build());
 108         nwBuilder.setNetworkTypes(nwTypeBuilder.build());
 109         return nwBuilder.build();
 110     }
 111 }