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