org.opendaylight.netconf.console.utils.NetconfConsoleUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netconf-console Show documentation
The newest version!
/*
 * Copyright (c) 2016 Inocybe Technologies and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.netconf.console.utils;

import com.google.common.util.concurrent.ListenableFuture;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import org.opendaylight.mdsal.binding.api.DataBroker;
import org.opendaylight.mdsal.binding.api.ReadTransaction;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev240911.NetconfNodeAugment;
import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev240911.netconf.node.augment.NetconfNode;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
import org.opendaylight.yangtools.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class NetconfConsoleUtils {
    private static final Logger LOG = LoggerFactory.getLogger(NetconfConsoleUtils.class);

    private NetconfConsoleUtils() {
        // Hidden on purpose
    }

    /**
     * Returns the NETCONF node associated with the given nodeId.
     * @param nodeId :Id of the NETCONF device
     * @param db :An instance of the {@link DataBroker}
     * @return A node, or null if it is not present
     */
    public static Node getNetconfNodeFromId(final String nodeId, final DataBroker db) {
        return read(LogicalDatastoreType.OPERATIONAL, NetconfIidFactory.netconfNodeIid(nodeId), db);
    }

    /**
     * Returns a list with one NETCONF node for the IP and Port.
     * @param deviceIp :IP address of NETCONF device
     * @param devicePort :Port of NETCONF device
     * @param db :An instance of the {@link DataBroker}
     * @return :NETCONF node instance
     */
    public static Node getNetconfNodeFromIpAndPort(final String deviceIp, final String devicePort,
                                                   final DataBroker db) {
        final Topology topology = read(LogicalDatastoreType.OPERATIONAL, NetconfIidFactory.NETCONF_TOPOLOGY_IID, db);
        for (Node node : netconfNodes(topology)) {
            final var netconfNodeAugment = node.augmentation(NetconfNodeAugment.class);
            final NetconfNode netconfNode = netconfNodeAugment != null ? netconfNodeAugment.getNetconfNode() : null;
            if (netconfNode != null && netconfNode.getHost().getIpAddress().getIpv4Address().getValue().equals(deviceIp)
                    && devicePort.equals(netconfNode.getPort().getValue().toString())) {
                return node;
            }
        }
        return null;
    }

    /**
     * Checks if the NETCONF topology contains nodes.
     * @param topology :NETCONF topology instance
     * @return :true if not empty, else, false
     */
    private static Collection netconfNodes(final Topology topology) {
        return topology == null ? List.of() : topology.nonnullNode().values();
    }

    /**
     * Blocking read transaction.
     * @param store :DatastoreType
     * @param path :InstanceIdentifier
     * @param db :An instance of the {@link DataBroker}
     * @return :data read from path
     */
    public static  D read(final LogicalDatastoreType store, final InstanceIdentifier path,
            final DataBroker db) {
        final ListenableFuture> future;
        try (ReadTransaction transaction = db.newReadOnlyTransaction()) {
            future = transaction.read(store, path);
        }

        final Optional optionalData;
        try {
            optionalData = future.get();
        } catch (InterruptedException | ExecutionException e) {
            LOG.warn("Failed to read {} ", path, e);
            return null;
        }

        if (optionalData.isPresent()) {
            return optionalData.orElseThrow();
        }

        if (LOG.isDebugEnabled()) {
            LOG.debug("{}: Failed to read {}", Thread.currentThread().getStackTrace()[1], path);
        }
        return null;
    }
}