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