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