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