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 Node node = getNodeIdBuilder(id)
  82                 .addAugmentation(new NetconfNodeBuilder()
  83                     .setConnectionStatus(ConnectionStatus.Connecting)
  84                     .setHost(id.getHost())
  85                     .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort()))).build())
  86                 .build();
  87
  88         LOG.trace("{}: Init device state transaction {} putting if absent operational data started.",
  89                 id, writeTx.getIdentifier());
  90         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), node);
  91         LOG.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
  92         LOG.trace("{}: Init device state transaction {} putting if absent config data started.",
  93                 id, writeTx.getIdentifier());
  94         LOG.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
  95
  96         commitTransaction(writeTx, "init");
  97     }
  98
  99     public void updateDeviceData(final ConnectionStatus connectionStatus,
 100             final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
 101         NetconfNode data;
 102         if (node != null && dsType == LogicalDatastoreType.CONFIGURATION) {
 103             data = node;
 104         } else {
 105             data = buildDataForNetconfNode(connectionStatus, capabilities, dsType, node);
 106         }
 107
 108         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 109         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 110                 id, writeTx.getIdentifier());
 111         writeTx.mergeParentStructurePut(dsType, id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
 112         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 113                 id, writeTx.getIdentifier());
 114
 115         commitTransaction(writeTx, "update");
 116     }
 117
 118     public void updateDeviceData(final boolean up, final NetconfDeviceCapabilities capabilities) {
 119         updateDeviceData(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting, capabilities,
 120                 LogicalDatastoreType.OPERATIONAL, null);
 121     }
 122
 123     public void updateClusteredDeviceData(final boolean up, final String masterAddress,
 124                                           final NetconfDeviceCapabilities capabilities) {
 125         final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
 126
 127         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 128         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 129                 id, writeTx.getIdentifier());
 130         writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
 131                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
 132         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 133                 id, writeTx.getIdentifier());
 134
 135         commitTransaction(writeTx, "update");
 136     }
 137
 138     public void setDeviceAsFailed(final Throwable throwable) {
 139         String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
 140
 141         final NetconfNode data = new NetconfNodeBuilder()
 142                 .setHost(id.getHost())
 143                 .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
 144                 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 145
 146         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 147         LOG.trace(
 148                 "{}: Setting device state as failed {} putting operational data started.",
 149                 id, writeTx.getIdentifier());
 150         writeTx.mergeParentStructurePut(LogicalDatastoreType.OPERATIONAL,
 151                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data);
 152         LOG.trace(
 153                 "{}: Setting device state as failed {} putting operational data ended.",
 154                 id, writeTx.getIdentifier());
 155
 156         commitTransaction(writeTx, "update-failed-device");
 157     }
 158
 159     private NetconfNode buildDataForNetconfNode(final ConnectionStatus connectionStatus,
 160             final NetconfDeviceCapabilities capabilities, final LogicalDatastoreType dsType, final NetconfNode node) {
 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         return new NetconfNodeBuilder()
 169             .setHost(id.getHost())
 170             .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
 171             .setConnectionStatus(connectionStatus)
 172             .setAvailableCapabilities(avCapabalitiesBuilder.build())
 173             .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
 174             .build();
 175     }
 176
 177     private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
 178                                                          final NetconfDeviceCapabilities capabilities) {
 179         List<AvailableCapability> capabilityList = new ArrayList<>();
 180         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 181         capabilityList.addAll(capabilities.getResolvedCapabilities());
 182         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 183         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 184
 185         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 186                 .setHost(id.getHost())
 187                 .setPort(new PortNumber(Uint16.valueOf(id.getAddress().getPort())))
 188                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 189                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 190                 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
 191                 .setClusteredConnectionStatus(
 192                         new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
 193
 194         return netconfNodeBuilder.build();
 195     }
 196
 197     private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
 198         return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
 199             e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
 200                 e.getValue()).build()).collect(Collectors.toList())).build();
 201     }
 202
 203     public void removeDeviceConfiguration() {
 204         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 205
 206         LOG.trace(
 207                 "{}: Close device state transaction {} removing all data started.",
 208                 id, writeTx.getIdentifier());
 209         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 210         LOG.trace(
 211                 "{}: Close device state transaction {} removing all data ended.",
 212                 id, writeTx.getIdentifier());
 213
 214         try {
 215             writeTx.commit().get();
 216         } catch (InterruptedException | ExecutionException e) {
 217             LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 218             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 219         }
 220     }
 221
 222     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 223
 224         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 225         LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
 226             NetworkTopology.QNAME);
 227         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 228
 229         final Topology topology =
 230                 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 231         LOG.trace("{}: Transaction {} merging {} container to ensure its presence", id, writeTx.getIdentifier(),
 232                 Topology.QNAME);
 233         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 234     }
 235
 236     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 237         LOG.trace("{}: Committing Transaction {}:{}", id, txType,
 238                 transaction.getIdentifier());
 239
 240         transaction.commit().addCallback(new FutureCallback<CommitInfo>() {
 241             @Override
 242             public void onSuccess(final CommitInfo result) {
 243                 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
 244                         transaction.getIdentifier());
 245             }
 246
 247             @Override
 248             public void onFailure(final Throwable throwable) {
 249                 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
 250                         transaction.getIdentifier(), throwable);
 251                 throw new IllegalStateException(
 252                         id + "  Transaction(" + txType + ") not committed correctly", throwable);
 253             }
 254         }, MoreExecutors.directExecutor());
 255     }
 256
 257     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 258         final NodeBuilder nodeBuilder = new NodeBuilder();
 259         nodeBuilder.withKey(new NodeKey(new NodeId(id.getName())));
 260         return nodeBuilder;
 261     }
 262
 263     @Override
 264     public void close() {
 265         removeDeviceConfiguration();
 266     }
 267
 268     public void setTxChain(final TransactionChain txChain) {
 269         this.txChain = requireNonNull(txChain);
 270     }
 271 }