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