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