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 package org.opendaylight.netconf.sal.connect.netconf.sal;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.util.concurrent.FutureCallback;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import com.google.common.util.concurrent.SettableFuture;
  16 import java.util.concurrent.ExecutionException;
  17 import java.util.stream.Collectors;
  18 import org.opendaylight.mdsal.binding.api.DataBroker;
  19 import org.opendaylight.mdsal.binding.api.Transaction;
  20 import org.opendaylight.mdsal.binding.api.TransactionChain;
  21 import org.opendaylight.mdsal.binding.api.TransactionChainListener;
  22 import org.opendaylight.mdsal.binding.api.WriteTransaction;
  23 import org.opendaylight.mdsal.common.api.CommitInfo;
  24 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  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.ClusteredConnectionStatusBuilder;
  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.UnavailableCapabilityBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  37 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  39 import org.opendaylight.yangtools.yang.common.Empty;
  40 import org.opendaylight.yangtools.yang.common.Uint16;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 public final class NetconfDeviceTopologyAdapter implements TransactionChainListener, AutoCloseable {
  45     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
  46
  47     private final SettableFuture<Empty> closeFuture = SettableFuture.create();
  48     private final DataBroker dataBroker;
  49     private final RemoteDeviceId id;
  50
  51     private TransactionChain txChain;
  52
  53     NetconfDeviceTopologyAdapter(final DataBroker dataBroker, final RemoteDeviceId id) {
  54         this.dataBroker = requireNonNull(dataBroker);
  55         this.id = requireNonNull(id);
  56         txChain = dataBroker.createMergingTransactionChain(this);
  57
  58         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
  59         LOG.trace("{}: Init device state transaction {} putting if absent operational data started.", id,
  60             writeTx.getIdentifier());
  61         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), getNodeIdBuilder(id)
  62             .addAugmentation(new NetconfNodeBuilder()
  63                 .setConnectionStatus(ConnectionStatus.Connecting)
  64                 .setHost(id.getHost())
  65                 .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort()))).build())
  66             .build());
  67         LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
  68
  69         commitTransaction(writeTx, "init");
  70     }
  71
  72     public void updateDeviceData(final ConnectionStatus connectionStatus,
  73             final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
  74         NetconfNode data;
  75         if (node != null && dsType == LogicalDatastoreType.CONFIGURATION) {
  76             data = node;
  77         } else {
  78             data = newNetconfNodeBuilder(connectionStatus, capabilities).build();
  79         }
  80
  81         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
  82         LOG.trace("{}: Update device state transaction {} merging operational data started.",
  83                 id, writeTx.getIdentifier());
  84         writeTx.mergeParentStructurePut(dsType, id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
  85         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
  86                 id, writeTx.getIdentifier());
  87
  88         commitTransaction(writeTx, "update");
  89     }
  90
  91     public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
  92         updateDeviceData(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities,
  93                 LogicalDatastoreType.OPERATIONAL, null);
  94     }
  95
  96     public void updateClusteredDeviceData(final boolean up, final String masterAddress,
  97                                           final NetconfDeviceCapabilities capabilities) {
  98         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
  99         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 100                 id, writeTx.getIdentifier());
 101         writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
 102             id.getTopologyBindingPath().augmentation(NetconfNode.class),
 103             newNetconfNodeBuilder(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities)
 104                 .setClusteredConnectionStatus(new ClusteredConnectionStatusBuilder()
 105                     .setNetconfMasterNode(masterAddress)
 106                     .build())
 107                 .build());
 108         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 109                 id, writeTx.getIdentifier());
 110
 111         commitTransaction(writeTx, "update");
 112     }
 113
 114     @Override
 115     public void onTransactionChainFailed(final TransactionChain chain, final Transaction transaction,
 116             final Throwable cause) {
 117         LOG.warn("{}: TransactionChain({}) {} FAILED!", id, chain, transaction.getIdentifier(), cause);
 118         chain.close();
 119
 120         txChain = dataBroker.createMergingTransactionChain(this);
 121         LOG.info("{}: TransactionChain reset to {}", id, txChain);
 122         // FIXME: restart last update
 123     }
 124
 125     @Override
 126     public void onTransactionChainSuccessful(final TransactionChain chain) {
 127         LOG.trace("{}: TransactionChain({}) SUCCESSFUL", id, chain);
 128         closeFuture.set(Empty.value());
 129     }
 130
 131     public void setDeviceAsFailed(final Throwable throwable) {
 132         String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : "Unknown reason";
 133
 134         final NetconfNode data = new NetconfNodeBuilder()
 135                 .setHost(id.getHost())
 136                 .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
 137                 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 138
 139         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 140         LOG.trace(
 141                 "{}: Setting device state as failed {} putting operational data started.",
 142                 id, writeTx.getIdentifier());
 143         writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
 144                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
 145         LOG.trace(
 146                 "{}: Setting device state as failed {} putting operational data ended.",
 147                 id, writeTx.getIdentifier());
 148
 149         commitTransaction(writeTx, "update-failed-device");
 150     }
 151
 152     private NetconfNodeBuilder newNetconfNodeBuilder(final ConnectionStatus connectionStatus,
 153             final NetconfDeviceCapabilities capabilities) {
 154         return new NetconfNodeBuilder()
 155             .setHost(id.getHost())
 156             .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
 157             .setConnectionStatus(connectionStatus)
 158             .setAvailableCapabilities(new AvailableCapabilitiesBuilder()
 159                 .setAvailableCapability(ImmutableList.<AvailableCapability>builder()
 160                     .addAll(capabilities.getNonModuleBasedCapabilities())
 161                     .addAll(capabilities.getResolvedCapabilities())
 162                     .build())
 163                 .build())
 164             .setUnavailableCapabilities(new UnavailableCapabilitiesBuilder()
 165                 .setUnavailableCapability(capabilities.getUnresolvedCapabilites().entrySet().stream()
 166                     .map(unresolved -> new UnavailableCapabilityBuilder()
 167                         // FIXME: better conversion than 'toString' ?
 168                         .setCapability(unresolved.getKey().toString())
 169                         .setFailureReason(unresolved.getValue())
 170                         .build())
 171                     .collect(Collectors.toUnmodifiableList()))
 172                 .build());
 173     }
 174
 175     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 176         LOG.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
 177
 178         transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
 179             @Override
 180             public void onSuccess(final CommitInfo result) {
 181                 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
 182             }
 183
 184             @Override
 185             public void onFailure(final Throwable throwable) {
 186                 LOG.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), throwable);
 187             }
 188         }, MoreExecutors.directExecutor());
 189     }
 190
 191     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 192         return new NodeBuilder().withKey(new NodeKey(new NodeId(id.getName())));
 193     }
 194
 195     @Override
 196     public void close() {
 197         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 198         LOG.trace("{}: Close device state transaction {} removing all data started.", id, writeTx.getIdentifier());
 199         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 200         LOG.trace("{}: Close device state transaction {} removing all data ended.", id, writeTx.getIdentifier());
 201         commitTransaction(writeTx, "close");
 202
 203         txChain.close();
 204
 205         try {
 206             closeFuture.get();
 207         } catch (InterruptedException | ExecutionException e) {
 208             LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 209             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 210         }
 211     }
 212 }