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