netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/WriteRunningTx.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
   9 package org.opendaylight.netconf.sal.connect.netconf.sal.tx;
  10
  11 import com.google.common.base.Function;
  12 import com.google.common.base.Optional;
  13 import com.google.common.util.concurrent.CheckedFuture;
  14 import com.google.common.util.concurrent.Futures;
  15 import com.google.common.util.concurrent.ListenableFuture;
  16 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  17 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  18 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  19 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfRpcFutureCallback;
  20 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  21 import org.opendaylight.yangtools.yang.common.RpcResult;
  22 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  25 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  26 import org.slf4j.Logger;
  27 import org.slf4j.LoggerFactory;
  28
  29 /**
  30  * Tx implementation for netconf devices that support only writable-running with no candidate
  31  * The sequence goes as:
  32  * <ol>
  33  *   <li>Lock running datastore on tx construction
  34  *     <ul>
  35  *       <li> Lock has to succeed, if it does not, transaction is failed</li>
  36  *     </ul>
  37  *   </li>
  38  *   <li>Edit-config in running N times
  39  *     <ul>
  40  *       <li>If any issue occurs during edit, datastore is unlocked and an exception is thrown</li>
  41  *     </ul>
  42  *   </li>
  43  *   <li>Unlock running datastore on tx commit</li>
  44  * </ol>
  45  */
  46 public class WriteRunningTx extends AbstractWriteTx {
  47
  48     private static final Logger LOG  = LoggerFactory.getLogger(WriteRunningTx.class);
  49
  50     public WriteRunningTx(final RemoteDeviceId id, final NetconfBaseOps netOps,
  51                           final boolean rollbackSupport) {
  52         super(netOps, id, rollbackSupport);
  53     }
  54
  55     @Override
  56     protected synchronized void init() {
  57         lock();
  58     }
  59
  60     private void lock() {
  61         resultsFutures.add(netOps.lockRunning(new NetconfRpcFutureCallback("Lock running", id)));
  62     }
  63
  64     @Override
  65     protected void cleanup() {
  66         unlock();
  67     }
  68
  69     @Override
  70     public synchronized CheckedFuture<Void, TransactionCommitFailedException> submit() {
  71         final ListenableFuture<Void> commmitFutureAsVoid = Futures.transform(commit(), new Function<RpcResult<TransactionStatus>, Void>() {
  72             @Override
  73             public Void apply(final RpcResult<TransactionStatus> input) {
  74                 return null;
  75             }
  76         });
  77
  78         return Futures.makeChecked(commmitFutureAsVoid, new Function<Exception, TransactionCommitFailedException>() {
  79             @Override
  80             public TransactionCommitFailedException apply(final Exception input) {
  81                 return new TransactionCommitFailedException("Submit of transaction " + getIdentifier() + " failed", input);
  82             }
  83         });
  84     }
  85
  86     @Override
  87     public synchronized ListenableFuture<RpcResult<TransactionStatus>> performCommit() {
  88         unlock();
  89
  90         return resultsToTxStatus();
  91     }
  92
  93     @Override
  94     protected void editConfig(final YangInstanceIdentifier path,
  95                               final Optional<NormalizedNode<?, ?>> data,
  96                               final DataContainerChild<?, ?> editStructure,
  97                               final Optional<ModifyAction> defaultOperation,
  98                               final String operation) {
  99
 100         NetconfRpcFutureCallback editConfigCallback = new NetconfRpcFutureCallback("Edit running", id);
 101
 102         if (defaultOperation.isPresent()) {
 103             resultsFutures.add(
 104                     netOps.editConfigRunning(editConfigCallback, editStructure, defaultOperation.get(), rollbackSupport));
 105         } else {
 106             resultsFutures.add(netOps.editConfigRunning(editConfigCallback, editStructure, rollbackSupport));
 107         }
 108     }
 109
 110     private void unlock() {
 111         netOps.unlockRunning(new NetconfRpcFutureCallback("Unlock running", id));
 112     }
 113 }