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