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 import java.util.ArrayList;
  18 import java.util.List;
  19 import java.util.Map.Entry;
  20 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
  24 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  25 import org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  26 import org.opendaylight.controller.md.sal.common.api.data.TransactionChainListener;
  27 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  28 import org.opendaylight.controller.sal.connect.netconf.listener.NetconfDeviceCapabilities;
  29 import org.opendaylight.controller.sal.connect.util.RemoteDeviceId;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev100924.PortNumber;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNode;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.NetconfNodeFields.ConnectionStatus;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.AvailableCapabilitiesBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilities;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.UnavailableCapabilitiesBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.unavailable.capabilities.UnavailableCapability.FailureReason;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.topology.rev150114.netconf.node.fields.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 final class NetconfDeviceTopologyAdapter implements AutoCloseable {
  58
  59     public static final Logger logger = 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     public static final Function<QName, String> AVAILABLE_CAPABILITY_TRANSFORMER = new Function<QName, String>() {
  69         @Override
  70         public String apply(QName qName) {
  71             return qName.toString();
  72         }
  73     };
  74
  75     private final RemoteDeviceId id;
  76     private final 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 DataBroker dataService) {
  83         this.id = id;
  84         this.txChain = Preconditions.checkNotNull(dataService).createTransactionChain(new TransactionChainListener() {
  85             @Override
  86             public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
  87                 logger.error("{}: TransactionChain({}) {} FAILED!", id, chain, transaction.getIdentifier(), cause);
  88                 throw new IllegalStateException(id + "  TransactionChain(" + chain + ") not committed correctly", cause);
  89             }
  90
  91             @Override
  92             public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
  93                 logger.trace("{}: TransactionChain({}) {} SUCCESSFUL", id, chain);
  94             }
  95         });
  96
  97         this.networkTopologyPath = InstanceIdentifier.builder(NetworkTopology.class).build();
  98         this.topologyListPath = networkTopologyPath.child(Topology.class, new TopologyKey(new TopologyId(TopologyNetconf.QNAME.getLocalName())));
  99
 100         initDeviceData();
 101     }
 102
 103      private void initDeviceData() {
 104         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 105
 106         createNetworkTopologyIfNotPresent(writeTx);
 107
 108         final InstanceIdentifier<Node> path = id.getTopologyBindingPath();
 109         NodeBuilder nodeBuilder = getNodeIdBuilder(id);
 110         NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
 111         netconfNodeBuilder.setConnectionStatus(ConnectionStatus.Connecting);
 112         netconfNodeBuilder.setHost(id.getHost());
 113         netconfNodeBuilder.setPort(new PortNumber(id.getAddress().getPort()));
 114         nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
 115         Node node = nodeBuilder.build();
 116
 117         logger.trace("{}: Init device state transaction {} putting if absent operational data started.", id, writeTx.getIdentifier());
 118         writeTx.put(LogicalDatastoreType.OPERATIONAL, path, node);
 119         logger.trace("{}: Init device state transaction {} putting operational data ended.", id, writeTx.getIdentifier());
 120
 121         logger.trace("{}: Init device state transaction {} putting if absent config data started.", id, writeTx.getIdentifier());
 122         writeTx.put(LogicalDatastoreType.CONFIGURATION, path, getNodeWithId(id));
 123         logger.trace("{}: Init device state transaction {} putting config data ended.", id, writeTx.getIdentifier());
 124
 125         commitTransaction(writeTx, "init");
 126     }
 127
 128     public void updateDeviceData(boolean up, NetconfDeviceCapabilities capabilities) {
 129         final Node data = buildDataForNetconfNode(up, capabilities);
 130
 131         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 132         logger.trace("{}: Update device state transaction {} merging operational data started.", id, writeTx.getIdentifier());
 133         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
 134         logger.trace("{}: Update device state transaction {} merging operational data ended.", 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         logger.trace("{}: Setting device state as failed {} putting operational data started.", id, writeTx.getIdentifier());
 147         writeTx.put(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath(), data);
 148         logger.trace("{}: Setting device state as failed {} putting operational data ended.", id, writeTx.getIdentifier());
 149
 150         commitTransaction(writeTx, "update-failed-device");
 151     }
 152
 153     private Node buildDataForNetconfNode(boolean up, NetconfDeviceCapabilities capabilities) {
 154         List<String> capabilityList = new ArrayList<>();
 155         capabilityList.addAll(capabilities.getNonModuleBasedCapabilities());
 156         capabilityList.addAll(FluentIterable.from(capabilities.getResolvedCapabilities()).transform(AVAILABLE_CAPABILITY_TRANSFORMER).toList());
 157         final AvailableCapabilitiesBuilder avCapabalitiesBuilder = new AvailableCapabilitiesBuilder();
 158         avCapabalitiesBuilder.setAvailableCapability(capabilityList);
 159
 160         final UnavailableCapabilities unavailableCapabilities =
 161                 new UnavailableCapabilitiesBuilder().setUnavailableCapability(FluentIterable.from(capabilities.getUnresolvedCapabilites().entrySet())
 162                         .transform(UNAVAILABLE_CAPABILITY_TRANSFORMER).toList()).build();
 163
 164         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder()
 165                 .setHost(id.getHost())
 166                 .setPort(new PortNumber(id.getAddress().getPort()))
 167                 .setConnectionStatus(up ? ConnectionStatus.Connected : ConnectionStatus.Connecting)
 168                 .setAvailableCapabilities(avCapabalitiesBuilder.build())
 169                 .setUnavailableCapabilities(unavailableCapabilities);
 170
 171         final NodeBuilder nodeBuilder = getNodeIdBuilder(id);
 172
 173         return nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build()).build();
 174     }
 175
 176     public void removeDeviceConfiguration() {
 177         final WriteTransaction writeTx = txChain.newWriteOnlyTransaction();
 178
 179         logger.trace("{}: Close device state transaction {} removing all data started.", id, writeTx.getIdentifier());
 180         writeTx.delete(LogicalDatastoreType.CONFIGURATION, id.getTopologyBindingPath());
 181         writeTx.delete(LogicalDatastoreType.OPERATIONAL, id.getTopologyBindingPath());
 182         logger.trace("{}: Close device state transaction {} removing all data ended.", id, writeTx.getIdentifier());
 183
 184         commitTransaction(writeTx, "close");
 185     }
 186
 187     private void createNetworkTopologyIfNotPresent(final WriteTransaction writeTx) {
 188
 189         final NetworkTopology networkTopology = new NetworkTopologyBuilder().build();
 190         logger.trace("{}: Merging {} container to ensure its presence", id, networkTopology.QNAME, writeTx.getIdentifier());
 191         writeTx.merge(LogicalDatastoreType.CONFIGURATION, networkTopologyPath, networkTopology);
 192         writeTx.merge(LogicalDatastoreType.OPERATIONAL, networkTopologyPath, networkTopology);
 193
 194         final Topology topology = new TopologyBuilder().setTopologyId(new TopologyId(TopologyNetconf.QNAME.getLocalName())).build();
 195         logger.trace("{}: Merging {} container to ensure its presence", id, topology.QNAME, writeTx.getIdentifier());
 196         writeTx.merge(LogicalDatastoreType.CONFIGURATION, topologyListPath, topology);
 197         writeTx.merge(LogicalDatastoreType.OPERATIONAL, topologyListPath, topology);
 198     }
 199
 200     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 201         logger.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
 202         final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
 203
 204         Futures.addCallback(result, new FutureCallback<Void>() {
 205             @Override
 206             public void onSuccess(final Void result) {
 207                 logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
 208             }
 209
 210             @Override
 211             public void onFailure(final Throwable t) {
 212                 logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), t);
 213                 throw new IllegalStateException(id + "  Transaction(" + txType + ") not committed correctly", t);
 214             }
 215         });
 216
 217     }
 218
 219     private static Node getNodeWithId(final RemoteDeviceId id) {
 220         final NodeBuilder builder = getNodeIdBuilder(id);
 221         return builder.build();
 222     }
 223
 224     private static NodeBuilder getNodeIdBuilder(final RemoteDeviceId id) {
 225         final NodeBuilder nodeBuilder = new NodeBuilder();
 226         nodeBuilder.setKey(new NodeKey(new NodeId(id.getName())));
 227         return nodeBuilder;
 228     }
 229
 230     @Override
 231     public void close() throws Exception {
 232         removeDeviceConfiguration();
 233         txChain.close();
 234     }
 235 }