netconf/netconf-console/src/main/java/org/opendaylight/netconf/console/utils/NetconfConsoleUtils.java

   1 /*
   2  * Copyright (c) 2016 Inocybe Technologies 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.netconf.console.utils;
  10
  11 import com.google.common.base.Optional;
  12 import com.google.common.util.concurrent.ListenableFuture;
  13 import java.util.ArrayList;
  14 import java.util.Arrays;
  15 import java.util.List;
  16 import java.util.concurrent.ExecutionException;
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  19 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  21 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  22 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 public final class NetconfConsoleUtils {
  28
  29     private static final Logger LOG = LoggerFactory.getLogger(NetconfConsoleUtils.class);
  30
  31     private NetconfConsoleUtils() {
  32         throw new IllegalStateException("Instantiating utility class.");
  33     }
  34
  35     /**
  36      * Returns a list of NETCONF nodes for the IP.
  37      * @param deviceIp :IP address of NETCONF device
  38      * @param db :An instance of the {@link DataBroker}
  39      * @return :list on NETCONF nodes
  40      */
  41     public static List<Node> getNetconfNodeFromIp(final String deviceIp, final DataBroker db) {
  42         final Topology topology = read(LogicalDatastoreType.OPERATIONAL, NetconfIidFactory.NETCONF_TOPOLOGY_IID, db);
  43         List<Node> nodes = new ArrayList<>();
  44         if (isNetconfNodesPresent(topology)) {
  45             for (Node node : topology.getNode()) {
  46                 final NetconfNode netconfNode = node.augmentation(NetconfNode.class);
  47                 if (netconfNode != null
  48                         && netconfNode.getHost().getIpAddress().getIpv4Address().getValue().equals(deviceIp)) {
  49                     nodes.add(node);
  50                 }
  51             }
  52         }
  53         return nodes.isEmpty() ? null : nodes;
  54     }
  55
  56     /**
  57      * Returns the NETCONF node associated with the given nodeId.
  58      * @param nodeId :Id of the NETCONF device
  59      * @param db :An instance of the {@link DataBroker}
  60      * @return :list on NETCONF nodes
  61      */
  62     public static List<Node> getNetconfNodeFromId(final String nodeId, final DataBroker db) {
  63         final Node node = read(LogicalDatastoreType.OPERATIONAL, NetconfIidFactory.netconfNodeIid(nodeId), db);
  64         if (node != null) {
  65             return Arrays.asList(node);
  66         }
  67         return null;
  68     }
  69
  70     /**
  71      * Returns a list with one NETCONF node for the IP and Port.
  72      * @param deviceIp :IP address of NETCONF device
  73      * @param devicePort :Port of NETCONF device
  74      * @param db :An instance of the {@link DataBroker}
  75      * @return :NETCONF node instance
  76      */
  77     public static Node getNetconfNodeFromIpAndPort(final String deviceIp, final String devicePort,
  78                                                    final DataBroker db) {
  79         final Topology topology = read(LogicalDatastoreType.OPERATIONAL, NetconfIidFactory.NETCONF_TOPOLOGY_IID, db);
  80         if (isNetconfNodesPresent(topology)) {
  81             for (Node node : topology.getNode()) {
  82                 final NetconfNode netconfNode = node.augmentation(NetconfNode.class);
  83                 if (netconfNode != null
  84                         && netconfNode.getHost().getIpAddress().getIpv4Address().getValue().equals(deviceIp)
  85                         && devicePort.equals(netconfNode.getPort().getValue().toString())) {
  86                     return node;
  87                 }
  88             }
  89         }
  90         return null;
  91     }
  92
  93     /**
  94      * Checks if the NETCONF topology contains nodes.
  95      * @param topology :NETCONF topology instance
  96      * @return :<code>true</code> if not empty, else, <code>false</code>
  97      */
  98     private static boolean isNetconfNodesPresent(final Topology topology) {
  99         return topology != null && topology.getNode() != null && !topology.getNode().isEmpty();
 100     }
 101
 102     /**
 103      * Wait for datastore to populate NETCONF data.
 104      * @param deviceIp :IP address of NETCONF device
 105      */
 106     public static void waitForUpdate(final String deviceIp) {
 107         try {
 108             Thread.sleep(NetconfConsoleConstants.DEFAULT_TIMEOUT_MILLIS);
 109         } catch (final InterruptedException e) {
 110             LOG.warn("Interrupted while waiting after Netconf node {}", deviceIp, e);
 111         }
 112     }
 113
 114     /**
 115      * Blocking read transaction.
 116      * @param store :DatastoreType
 117      * @param path :InstanceIdentifier
 118      * @param db :An instance of the {@link DataBroker}
 119      * @return :data read from path
 120      */
 121     public static <D extends org.opendaylight.yangtools.yang.binding.DataObject> D read(
 122             final LogicalDatastoreType store, final InstanceIdentifier<D> path, final DataBroker db) {
 123         final ListenableFuture<Optional<D>> future;
 124         try (ReadOnlyTransaction transaction = db.newReadOnlyTransaction()) {
 125             future = transaction.read(store, path);
 126         }
 127
 128         final Optional<D> optionalData;
 129         try {
 130             optionalData = future.get();
 131         } catch (InterruptedException | ExecutionException e) {
 132             LOG.warn("Failed to read {} ", path, e);
 133             return null;
 134         }
 135
 136         if (optionalData.isPresent()) {
 137             return optionalData.get();
 138         }
 139
 140         LOG.debug("{}: Failed to read {}", Thread.currentThread().getStackTrace()[1], path);
 141         return null;
 142     }
 143 }