olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java

   1 /*
   2  * Copyright © 2017 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 package org.opendaylight.transportpce.olm.util;
   9
  10 import java.util.Optional;
  11 import java.util.concurrent.ExecutionException;
  12 import java.util.concurrent.TimeUnit;
  13 import java.util.concurrent.TimeoutException;
  14
  15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  16 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.transportpce.common.device.DeviceTransactionManager;
  19 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev170418.GetPmInput;
  20 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.olm.rev170418.GetPmOutputBuilder;
  21 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.Network;
  22 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.Nodes;
  23 import org.opendaylight.yang.gen.v1.http.org.opendaylight.transportpce.portmapping.rev170228.network.NodesKey;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  25 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  26 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  27 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  28 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  29 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  30 import org.slf4j.Logger;
  31 import org.slf4j.LoggerFactory;
  32
  33 public final class OlmUtils {
  34
  35     private static final Logger LOG = LoggerFactory.getLogger(OlmUtils.class);
  36     private static long DATABROKER_READ_TIMEOUT_SECONDS = 120;
  37     private static final InstanceIdentifier<Topology> NETCONF_TOPO_IID =
  38         InstanceIdentifier
  39             .create(NetworkTopology.class)
  40             .child(Topology.class,
  41                 new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
  42
  43     /**
  44      * This static method returns the port mapping {@link Nodes} for node.
  45      *
  46      * @param nodeId
  47      *            Unique identifier for the mounted netconf node
  48      * @param db
  49      *            Databroker used to read data from data store.
  50      * @return {@link Nodes } from portMapping for given nodeId
  51      */
  52     public static Optional<Nodes> getNode(String nodeId, DataBroker db) {
  53         InstanceIdentifier<Nodes> nodesIID = InstanceIdentifier.create(Network.class)
  54             .child(Nodes.class, new NodesKey(nodeId));
  55         try (ReadOnlyTransaction readTransaction = db.newReadOnlyTransaction()) {
  56             return readTransaction.read(LogicalDatastoreType.CONFIGURATION, nodesIID)
  57                 .get(DATABROKER_READ_TIMEOUT_SECONDS, TimeUnit.SECONDS).toJavaUtil();
  58         } catch (InterruptedException | ExecutionException | TimeoutException ex) {
  59             LOG.error("Unable to read Portmapping for nodeId {}", nodeId, ex);
  60             return Optional.empty();
  61         }
  62     }
  63
  64     /**
  65      * This method retrieves list of current PMs for given nodeId,
  66      * resourceType, resourceName and Granularity.Currently vendorExtentions
  67      * are excluded but can be added back based on requirement
  68      *
  69      * <p>
  70      * 1. pmFetch This operation traverse through current PM list and gets PM for
  71      * given NodeId and Resource name
  72      *
  73      * @param input
  74      *            Input parameter from the olm yang model get-pm rpc
  75      * @param deviceTransactionManager
  76      *            Device tx manager
  77      *
  78      * @return Result of the request list of PM readings
  79      */
  80     public static GetPmOutputBuilder pmFetch(GetPmInput input, DeviceTransactionManager deviceTransactionManager,
  81                                              Nodes.OpenroadmVersion openRoadmVersion) {
  82         LOG.debug("Getting PM Data for NodeId: {} ResourceType: {} ResourceName: {}", input.getNodeId(),
  83             input.getResourceType(), input.getResourceIdentifier());
  84         GetPmOutputBuilder pmOutputBuilder = new GetPmOutputBuilder();
  85         if (openRoadmVersion.equals(Nodes.OpenroadmVersion._121)) {
  86             pmOutputBuilder = OlmUtils1_2_1.pmFetch(input, deviceTransactionManager);
  87         } else {
  88             pmOutputBuilder = OlmUtils2_2.pmFetch(input, deviceTransactionManager);
  89         }
  90         return pmOutputBuilder;
  91     }
  92
  93     private OlmUtils() {
  94     }
  95
  96 }