netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/NetconfDeviceTopologyAdapter.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.sal.connect.netconf.sal;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Preconditions;
  13 import com.google.common.collect.FluentIterable;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.FutureCallback;
  16 import com.google.common.util.concurrent.Futures;
  17 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.Map.Entry;
  20 import java.util.concurrent.ExecutionException;
  21 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  24 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  25 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  26 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilitiesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.available.capabilities.AvailableCapability;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapability.FailureReason;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  48 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  49 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  51 import org.opendaylight.yangtools.yang.common.QName;
  52 import org.slf4j.Logger;
  53 import org.slf4j.LoggerFactory;
  54
  55 final class NetconfDeviceTopologyAdapter implements AutoCloseable {
  56
  57     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
  58     public static final Function<Entry<QName, FailureReason>, UnavailableCapability> UNAVAILABLE_CAPABILITY_TRANSFORMER = new Function<Entry<QName, FailureReason>, UnavailableCapability>() {
  59         @Override
  60         public UnavailableCapability apply(final Entry<QName, FailureReason> input) {
  61             return new UnavailableCapabilityBuilder()
  62                     .setCapability(input.getKey().toString())
  63                     .setFailureReason(input.getValue()).build();
  64         }
  65     };
  66
  67     private final RemoteDeviceId id;
  68     private BindingTransactionChain txChain;
  69
  70     private final InstanceIdentifier<NetworkTopology> networkTopologyPath;
  71     private final KeyedInstanceIdentifier<Topology, TopologyKey> topologyListPath;
  72     private static final String UNKNOWN_REASON = "Unknown reason";
  73
  74     NetconfDeviceTopologyAdapter(final RemoteDeviceId id, final BindingTransactionChain txChain) {
  75         this.id = id;
  76         this.txChain = Preconditions.checkNotNull(txChain);
  77
  78         this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
  79         this.topologyListPath = networkTopologyPath.child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
  80
  81         initDeviceData();
  82     }
  83
  84     private void initDeviceData() {
  85         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
  86
  87         createNetworkTopologyIfNotPresent(writeTx);
  88
  89         final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
  90         NodeBuilder nodeBuilder = getNodeIdBuilder(id);
  91         NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
  92         netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
  93         netconfNodeBuilder.setHost(id.getHost());
  94         netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
  95         nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
  96         Node node = nodeBuilder.build();
  97
  98         LOG.trace(
  99                 "{}: Init device state transaction {} putting if absent operational data started.",
 100                 id, writeTx.getIdentifier());
 101         writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
 102         LOG.trace(
 103                 "{}: Init device state transaction {} putting operational data ended.",
 104                 id, writeTx.getIdentifier());
 105
 106         LOG.trace(
 107                 "{}: Init device state transaction {} putting if absent config data started.",
 108                 id, writeTx.getIdentifier());
 109         LOG.trace(
 110                 "{}: Init device state transaction {} putting config data ended.",
 111                 id, writeTx.getIdentifier());
 112
 113         commitTransaction(writeTx, "init");
 114     }
 115
 116     public void updateDeviceData(boolean up, NetconfDeviceCapabilities capabilities) {
 117         final NetconfNode data = buildDataForNetconfNode(up, capabilities);
 118
 119         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 120         LOG.trace(
 121                 "{}: Update device state transaction {} merging operational data started.",
 122                 id, writeTx.getIdentifier());
 123         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
 124         LOG.trace(
 125                 "{}: Update device state transaction {} merging operational data ended.",
 126                 id, writeTx.getIdentifier());
 127
 128         commitTransaction(writeTx, "update");
 129     }
 130
 131     public void setDeviceAsFailed(Throwable throwable) {
 132         String reason = (throwable != null && throwable.getMessage() != null) ? throwable.getMessage() : UNKNOWN_REASON;
 133
 134         final NetconfNode data = new NetconfNodeBuilder().setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 135
 136         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 137         LOG.trace(
 138                 "{}: Setting device state as failed {} putting operational data started.",
 139                 id, writeTx.getIdentifier());
 140         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
 141         LOG.trace(
 142                 "{}: Setting device state as failed {} putting operational data ended.",
 143                 id, writeTx.getIdentifier());
 144
 145         commitTransaction(writeTx, "update-failed-device");
 146     }
 147
 148     private NetconfNode buildDataForNetconfNode(boolean up, NetconfDeviceCapabilities capabilities) {
 149         List<AvailableCapability> capabilityList = new ArrayList<>();
 150         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 151         capabilityList.addAll(capabilities.getResolvedCapabilities());
 152
 153         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 154         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 155
 156         final UnavailableCapabilities unavailableCapabilities =
 157                 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
 158                         .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
 159
 160         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 161                 .setHost(id.getHost())
 162                 .setPort(new PortNumber(id.getAddress().getPort()))
 163                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 164                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 165                 .setUnavailableCapabilities(unavailableCapabilities);
 166
 167         return netconfNodeBuilder.build();
 168     }
 169
 170     public void removeDeviceConfiguration() {
 171         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 172
 173         LOG.trace(
 174                 "{}: Close device state transaction {} removing all data started.",
 175                 id, writeTx.getIdentifier());
 176         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 177         LOG.trace(
 178                 "{}: Close device state transaction {} removing all data ended.",
 179                 id, writeTx.getIdentifier());
 180
 181         try {
 182             writeTx.submit().get();
 183         } catch (InterruptedException | ExecutionException e) {
 184             LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 185             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 186         }
 187     }
 188
 189     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 190
 191         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 192         LOG.trace("{}: Merging {} container to ensure its presence", id,
 193                 networkTopology.QNAME, writeTx.getIdentifier());
 194         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 195
 196         final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 197         LOG.trace("{}: Merging {} container to ensure its presence", id,
 198                 topology.QNAME, writeTx.getIdentifier());
 199         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 200     }
 201
 202     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 203         LOG.trace("{}: Committing Transaction {}:{}", id, txType,
 204                 transaction.getIdentifier());
 205         final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
 206
 207         Futures.addCallback(result, new FutureCallback<Void>() {
 208             @Override
 209             public void onSuccess(final Void result) {
 210                 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
 211                         transaction.getIdentifier());
 212             }
 213
 214             @Override
 215             public void onFailure(final Throwable t) {
 216                 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
 217                         transaction.getIdentifier(), t);
 218                 throw new IllegalStateException(id + "  Transaction(" + txType + ") not committed correctly", t);
 219             }
 220         });
 221
 222     }
 223
 224     private static Node getNodeWithId(final RemoteDeviceId id) {
 225         final NodeBuilder builder = getNodeIdBuilder(id);
 226         return builder.build();
 227     }
 228
 229     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 230         final NodeBuilder nodeBuilder = new NodeBuilder();
 231         nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
 232         return nodeBuilder;
 233     }
 234
 235     @Override
 236     public void close() throws Exception {
 237         removeDeviceConfiguration();
 238     }
 239
 240     public void setTxChain(BindingTransactionChain txChain) {
 241         this.txChain = Preconditions.checkNotNull(txChain);
 242     }
 243 }