opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/sal/NetconfDeviceDatastoreAdapter.java

   1 /*
   2  * Copyright (c) 2014 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 package org.opendaylight.controller.sal.connect.netconf.sal;
   9
  10 import com.google.common.base.Function;
  11 import com.google.common.base.Optional;
  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 com.google.common.util.concurrent.ListenableFuture;
  18 import java.util.Set;
  19 import org.opendaylight.controller.md.sal.binding.api.BindingTransactionChain;
  20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  21 import org.opendaylight.controller.md.sal.binding.api.ReadWriteTransaction;
  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.util.RemoteDeviceId;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodesBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.inventory.rev140108.NetconfNode;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.netconf.node.inventory.rev140108.NetconfNodeBuilder;
  35 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  36 import org.opendaylight.yangtools.yang.common.QName;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * Asynchronous (Binding-aware) adapter over datastore subtree for netconf device.
  42  *
  43  * All data changes are submitted to an ExecutorService to avoid Thread blocking while sal is waiting for schema.
  44  *
  45  * @deprecated Data is pushed into Topology instead if Inventory model
  46  */
  47 @Deprecated
  48 final class NetconfDeviceDatastoreAdapter implements AutoCloseable {
  49
  50     private static final Logger logger  = LoggerFactory.getLogger(NetconfDeviceDatastoreAdapter.class);
  51
  52     private final RemoteDeviceId id;
  53     private final BindingTransactionChain txChain;
  54
  55     NetconfDeviceDatastoreAdapter(final RemoteDeviceId deviceId, final DataBroker dataService) {
  56         this.id = Preconditions.checkNotNull(deviceId);
  57         this.txChain = Preconditions.checkNotNull(dataService).createTransactionChain(new TransactionChainListener() {
  58             @Override
  59             public void onTransactionChainFailed(TransactionChain<?, ?> chain, AsyncTransaction<?, ?> transaction, Throwable cause) {
  60                 logger.error("{}: TransactionChain({}) {} FAILED!", id, chain, transaction.getIdentifier(), cause);
  61                 throw new IllegalStateException(id + "  TransactionChain(" + chain + ") not committed correctly", cause);
  62             }
  63
  64             @Override
  65             public void onTransactionChainSuccessful(TransactionChain<?, ?> chain) {
  66                 logger.trace("{}: TransactionChain({}) {} SUCCESSFUL", id, chain);
  67             }
  68         });
  69
  70         initDeviceData();
  71     }
  72
  73     public void updateDeviceState(final boolean up, final Set<QName> capabilities) {
  74         final org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node data = buildDataForDeviceState(
  75                 up, capabilities, id);
  76
  77         final ReadWriteTransaction transaction = txChain.newReadWriteTransaction();
  78         logger.trace("{}: Update device state transaction {} merging operational data started.", id, transaction.getIdentifier());
  79         transaction.put(LogicalDatastoreType.OPERATIONAL, id.getBindingPath(), data);
  80         logger.trace("{}: Update device state transaction {} merging operational data ended.", id, transaction.getIdentifier());
  81
  82         commitTransaction(transaction, "update");
  83     }
  84
  85     private void removeDeviceConfigAndState() {
  86         final WriteTransaction transaction = txChain.newWriteOnlyTransaction();
  87         logger.trace("{}: Close device state transaction {} removing all data started.", id, transaction.getIdentifier());
  88         transaction.delete(LogicalDatastoreType.CONFIGURATION, id.getBindingPath());
  89         transaction.delete(LogicalDatastoreType.OPERATIONAL, id.getBindingPath());
  90         logger.trace("{}: Close device state transaction {} removing all data ended.", id, transaction.getIdentifier());
  91
  92         commitTransaction(transaction, "close");
  93     }
  94
  95     private void initDeviceData() {
  96         final WriteTransaction transaction = txChain.newWriteOnlyTransaction();
  97
  98         createNodesListIfNotPresent(transaction);
  99
 100         final InstanceIdentifier<Node> path = id.getBindingPath();
 101         final Node nodeWithId = getNodeWithId(id);
 102
 103         logger.trace("{}: Init device state transaction {} putting if absent operational data started.", id, transaction.getIdentifier());
 104         transaction.put(LogicalDatastoreType.OPERATIONAL, path, nodeWithId);
 105         logger.trace("{}: Init device state transaction {} putting operational data ended.", id, transaction.getIdentifier());
 106
 107         logger.trace("{}: Init device state transaction {} putting if absent config data started.", id, transaction.getIdentifier());
 108         transaction.put(LogicalDatastoreType.CONFIGURATION, path, nodeWithId);
 109         logger.trace("{}: Init device state transaction {} putting config data ended.", id, transaction.getIdentifier());
 110
 111         commitTransaction(transaction, "init");
 112     }
 113
 114     private void createNodesListIfNotPresent(final WriteTransaction writeTx) {
 115         final Nodes nodes = new NodesBuilder().build();
 116         final InstanceIdentifier<Nodes> path = InstanceIdentifier.builder(Nodes.class).build();
 117         logger.trace("{}: Merging {} container to ensure its presence", id, Nodes.QNAME, writeTx.getIdentifier());
 118         writeTx.merge(LogicalDatastoreType.CONFIGURATION, path, nodes);
 119         writeTx.merge(LogicalDatastoreType.OPERATIONAL, path, nodes);
 120     }
 121
 122     private void commitTransaction(final WriteTransaction transaction, final String txType) {
 123         logger.trace("{}: Committing Transaction {}:{}", id, txType, transaction.getIdentifier());
 124         final CheckedFuture<Void, TransactionCommitFailedException> result = transaction.submit();
 125
 126         Futures.addCallback(result, new FutureCallback<Void>() {
 127             @Override
 128             public void onSuccess(final Void result) {
 129                 logger.trace("{}: Transaction({}) {} SUCCESSFUL", id, txType, transaction.getIdentifier());
 130             }
 131
 132             @Override
 133             public void onFailure(final Throwable t) {
 134                 logger.error("{}: Transaction({}) {} FAILED!", id, txType, transaction.getIdentifier(), t);
 135                 throw new IllegalStateException(id + "  Transaction(" + txType + ") not committed correctly", t);
 136             }
 137         });
 138
 139     }
 140
 141     @Override
 142     public void close() throws Exception {
 143         removeDeviceConfigAndState();
 144         txChain.close();
 145     }
 146
 147     public static org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node buildDataForDeviceState(
 148             final boolean up, final Set<QName> capabilities, final RemoteDeviceId id) {
 149
 150         final NodeBuilder nodeBuilder = getNodeWithIdBuilder(id);
 151         final NetconfNodeBuilder netconfNodeBuilder = new NetconfNodeBuilder();
 152         netconfNodeBuilder.setConnected(up);
 153         netconfNodeBuilder.setInitialCapability(FluentIterable.from(capabilities)
 154                 .transform(new Function<QName, String>() {
 155                     @Override
 156                     public String apply(final QName input) {
 157                         return input.toString();
 158                     }
 159                 }).toList());
 160         nodeBuilder.addAugmentation(NetconfNode.class, netconfNodeBuilder.build());
 161
 162         return nodeBuilder.build();
 163     }
 164
 165     private static ListenableFuture<Optional<Node>> readNodeData(
 166             final LogicalDatastoreType store,
 167             final ReadWriteTransaction transaction,
 168             final InstanceIdentifier<Node> path) {
 169         return transaction.read(store, path);
 170     }
 171
 172     private static Node getNodeWithId(final RemoteDeviceId id) {
 173         final NodeBuilder nodeBuilder = getNodeWithIdBuilder(id);
 174         return nodeBuilder.build();
 175     }
 176
 177     private static NodeBuilder getNodeWithIdBuilder(final RemoteDeviceId id) {
 178         final NodeBuilder nodeBuilder = new NodeBuilder();
 179         nodeBuilder.setKey(id.getBindingKey());
 180         nodeBuilder.setId(id.getBindingKey().getId());
 181         return nodeBuilder;
 182     }
 183 }