opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/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.controller.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.controller.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  28 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.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.NetconfNodeFields.ConnectionStatus;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.AvailableCapabilitiesBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilities;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilitiesBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability.FailureReason;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.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     public static final Logger logger = 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         logger.trace("{}: Init device state transaction {} putting if absent operational data started.", id, writeTx.getIdentifier());
 107         writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
 108         logger.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
 109
 110         logger.trace("{}: Init device state transaction {} putting if absent config data started.", id, writeTx.getIdentifier());
 111         writeTx.put(LogicalDatastoreType.CONFIGURATION, path, getNodeWithId(id));
 112         logger.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
 113
 114         commitTransaction(writeTx, "init");
 115     }
 116
 117     public void updateDeviceData(boolean up, NetconfDeviceCapabilities capabilities) {
 118         final Node data = buildDataForNetconfNode(up, capabilities);
 119
 120         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 121         logger.trace("{}: Update device state transaction {} merging operational data started.", id, writeTx.getIdentifier());
 122         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
 123         logger.trace("{}: Update device state transaction {} merging operational data ended.", id, writeTx.getIdentifier());
 124
 125         commitTransaction(writeTx, "update");
 126     }
 127
 128     public void setDeviceAsFailed(Throwable throwable) {
 129         String reason = (throwable != null && throwable.getMessage() != null) ? throwable.getMessage() : UNKNOWN_REASON;
 130
 131         final NetconfNode netconfNode = new NetconfNodeBuilder().setConnectionStatus(ConnectionStatus.UnableToConnect).setConnectedMessage(reason).build();
 132         final Node data = getNodeIdBuilder(id).addAugmentation(NetconfNode.class, netconfNode).build();
 133
 134         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 135         logger.trace("{}: Setting device state as failed {} putting operational data started.", id, writeTx.getIdentifier());
 136         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
 137         logger.trace("{}: Setting device state as failed {} putting operational data ended.", id, writeTx.getIdentifier());
 138
 139         commitTransaction(writeTx, "update-failed-device");
 140     }
 141
 142     private Node buildDataForNetconfNode(boolean up, NetconfDeviceCapabilities capabilities) {
 143         List<String> capabilityList = new ArrayList<>();
 144         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 145         capabilityList.addAll(FluentIterable.from(capabilities.getResolvedCapabilities()).transform(AVAILABLE_CAPABILITY_TRANSFORMER).toList());
 146         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 147         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 148
 149         final UnavailableCapabilities unavailableCapabilities =
 150                 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
 151                         .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
 152
 153         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 154                 .setHost(id.getHost())
 155                 .setPort(new PortNumber(id.getAddress().getPort()))
 156                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 157                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 158                 .setUnavailableCapabilities(unavailableCapabilities);
 159
 160         final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
 161
 162         return nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build()).build();
 163     }
 164
 165     public void removeDeviceConfiguration() {
 166         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 167
 168         logger.trace("{}: Close device state transaction {} removing all data started.", id, writeTx.getIdentifier());
 169         writeTx.delete(LogicalDatastoreType.CONFIGURATION, id.getTopologyBindingPath());
 170         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 171         logger.trace("{}: Close device state transaction {} removing all data ended.", id, writeTx.getIdentifier());
 172
 173         try {
 174             writeTx.submit().get();
 175         } catch (InterruptedException | ExecutionException e) {
 176             logger.error("{}: Transaction(close) {} FAILED!", id, writeTx.getIdentifier(), e);
 177             throw new IllegalStateException(id + "  Transaction(close) not committed correctly", e);
 178         }
 179     }
 180
 181     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 182
 183         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 184         logger.trace("{}: Merging {} container to ensure its presence", id, networkTopology.QNAME, writeTx.getIdentifier());
 185         writeTx.merge(LogicalDatastoreType.CONFIGURATION, networkTopologyPath, networkTopology);
 186         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 187
 188         final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 189         logger.trace("{}: Merging {} container to ensure its presence", id, topology.QNAME, writeTx.getIdentifier());
 190         writeTx.merge(LogicalDatastoreType.CONFIGURATION, topologyListPath, topology);
 191         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 192     }
 193
 194     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 195         logger.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
 196         final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
 197
 198         Futures.addCallback(result, new FutureCallback<Void>() {
 199             @Override
 200             public void onSuccess(final Void result) {
 201                 logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
 202             }
 203
 204             @Override
 205             public void onFailure(final Throwable t) {
 206                 logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), t);
 207                 throw new IllegalStateException(id + "  Transaction(" + txType + ") not committed correctly", t);
 208             }
 209         });
 210
 211     }
 212
 213     private static Node getNodeWithId(final RemoteDeviceId id) {
 214         final NodeBuilder builder = getNodeIdBuilder(id);
 215         return builder.build();
 216     }
 217
 218     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 219         final NodeBuilder nodeBuilder = new NodeBuilder();
 220         nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
 221         return nodeBuilder;
 222     }
 223
 224     @Override
 225     public void close() throws Exception {
 226         removeDeviceConfiguration();
 227     }
 228
 229     public void setTxChain(BindingTransactionChain txChain) {
 230         this.txChain = Preconditions.checkNotNull(txChain);
 231     }
 232 }