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