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 java.util.ArrayList;
  16 import java.util.List;
  17 import java.util.Map;
  18 import java.util.concurrent.ExecutionException;
  19 import java.util.stream.Collectors;
  20 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  23 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  24 import org.opendaylight.netconf.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  25 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeConnectionStatus.ConnectionStatus;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.AvailableCapabilitiesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.ClusteredConnectionStatusBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.UnavailableCapabilities;
  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.UnavailableCapability.FailureReason;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.connection.status.unavailable.capabilities.UnavailableCapabilityBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.network.topology.topology.topology.types.TopologyNetconf;
  38 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopology;
  39 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NetworkTopologyBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  41 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId;
  42 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.Topology;
  43 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyBuilder;
  44 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.TopologyKey;
  45 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.Node;
  46 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.network.topology.topology.NodeKey;
  48 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
  50 import org.opendaylight.yangtools.yang.common.QName;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 public final class NetconfDeviceTopologyAdapter implements AutoCloseable {
  55
  56     private static final Logger LOG = LoggerFactory.getLogger(NetconfDeviceTopologyAdapter.class);
  57
  58     private final RemoteDeviceId id;
  59     private BindingTransactionChain 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 BindingTransactionChain txChain) {
  66         this.id = id;
  67         this.txChain = Preconditions.checkNotNull(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(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 boolean up, final NetconfDeviceCapabilities capabilities) {
 102         final NetconfNode data = buildDataForNetconfNode(up, capabilities);
 103
 104         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 105         LOG.trace("{}: Update device state transaction {} merging operational data started.",
 106                 id, writeTx.getIdentifier());
 107         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath().augmentation(NetconfNode.class),
 108             data, true);
 109         LOG.trace("{}: Update device state transaction {} merging operational data ended.",
 110                 id, writeTx.getIdentifier());
 111
 112         commitTransaction(writeTx, "update");
 113     }
 114
 115     public void updateClusteredDeviceData(final boolean up, final String masterAddress,
 116                                           final NetconfDeviceCapabilities capabilities) {
 117         final NetconfNode data = buildDataForNetconfClusteredNode(up, masterAddress, capabilities);
 118
 119         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 120         LOG.trace("{}: 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("{}: Update device state transaction {} merging operational data ended.",
 125                 id, writeTx.getIdentifier());
 126
 127         commitTransaction(writeTx, "update");
 128     }
 129
 130     public void setDeviceAsFailed(final Throwable throwable) {
 131         String reason = throwable != null && throwable.getMessage() != null ? throwable.getMessage() : UNKNOWN_REASON;
 132
 133         final NetconfNode data = new NetconfNodeBuilder()
 134                 .setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 135
 136         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 137         LOG.trace(
 138                 "{}: Setting device state as failed {} putting operational data started.",
 139                 id, writeTx.getIdentifier());
 140         writeTx.put(LogicalDatastoreType.OPERATIONAL,
 141                 id.getTopologyBindingPath().augmentation(NetconfNode.class), data, true);
 142         LOG.trace(
 143                 "{}: Setting device state as failed {} putting operational data ended.",
 144                 id, writeTx.getIdentifier());
 145
 146         commitTransaction(writeTx, "update-failed-device");
 147     }
 148
 149     private NetconfNode buildDataForNetconfNode(final boolean up, final NetconfDeviceCapabilities capabilities) {
 150         List<AvailableCapability> capabilityList = new ArrayList<>();
 151         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 152         capabilityList.addAll(capabilities.getResolvedCapabilities());
 153
 154         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 155         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 156
 157         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 158                 .setHost(id.getHost())
 159                 .setPort(new PortNumber(id.getAddress().getPort()))
 160                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 161                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 162                 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()));
 163
 164         return netconfNodeBuilder.build();
 165     }
 166
 167     private NetconfNode buildDataForNetconfClusteredNode(final boolean up, final String masterNodeAddress,
 168                                                          final NetconfDeviceCapabilities capabilities) {
 169         List<AvailableCapability> capabilityList = new ArrayList<>();
 170         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 171         capabilityList.addAll(capabilities.getResolvedCapabilities());
 172         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 173         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 174
 175         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 176                 .setHost(id.getHost())
 177                 .setPort(new PortNumber(id.getAddress().getPort()))
 178                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 179                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 180                 .setUnavailableCapabilities(unavailableCapabilities(capabilities.getUnresolvedCapabilites()))
 181                 .setClusteredConnectionStatus(
 182                         new ClusteredConnectionStatusBuilder().setNetconfMasterNode(masterNodeAddress).build());
 183
 184         return netconfNodeBuilder.build();
 185     }
 186
 187     private static UnavailableCapabilities unavailableCapabilities(final Map<QName, FailureReason> input) {
 188         return new UnavailableCapabilitiesBuilder().setUnavailableCapability(input.entrySet().stream().map(
 189             e -> new UnavailableCapabilityBuilder().setCapability(e.getKey().toString()).setFailureReason(
 190                 e.getValue()).build()).collect(Collectors.toList())).build();
 191     }
 192
 193     public void removeDeviceConfiguration() {
 194         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 195
 196         LOG.trace(
 197                 "{}: Close device state transaction {} removing all data started.",
 198                 id, writeTx.getIdentifier());
 199         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 200         LOG.trace(
 201                 "{}: Close device state transaction {} removing all data ended.",
 202                 id, writeTx.getIdentifier());
 203
 204         try {
 205             writeTx.submit().get();
 206         } catch (InterruptedException | ExecutionException e) {
 207             LOG.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 208             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 209         }
 210     }
 211
 212     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 213
 214         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 215         LOG.trace("{}: Merging {} container to ensure its presence", id,
 216                 NetworkTopology.QNAME, writeTx.getIdentifier());
 217         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 218
 219         final Topology topology =
 220                 new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 221         LOG.trace("{}: Merging {} container to ensure its presence", id,
 222                 Topology.QNAME, writeTx.getIdentifier());
 223         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 224     }
 225
 226     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 227         LOG.trace("{}: Committing Transaction {}:{}", id, txType,
 228                 transaction.getIdentifier());
 229         final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
 230
 231         Futures.addCallback(result, new FutureCallback<Void>() {
 232             @Override
 233             public void onSuccess(final Void result) {
 234                 LOG.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType,
 235                         transaction.getIdentifier());
 236             }
 237
 238             @Override
 239             public void onFailure(final Throwable throwable) {
 240                 LOG.error("{}: Transaction({}) {} FAILED!", id, txType,
 241                         transaction.getIdentifier(), throwable);
 242                 throw new IllegalStateException(
 243                         id + "  Transaction(" + txType + ") not committed correctly", throwable);
 244             }
 245         });
 246
 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 }