netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/sal/tx/WriteCandidateTx.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.util.concurrent.FutureCallback;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import com.google.common.util.concurrent.MoreExecutors;
  15 import java.util.Optional;
  16 import javax.annotation.Nonnull;
  17 import javax.annotation.Nullable;
  18 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  19 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  20 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfRpcFutureCallback;
  21 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  22 import org.opendaylight.yangtools.yang.common.RpcResult;
  23 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  26 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 /**
  31  * Tx implementation for netconf devices that support only candidate datastore and no writable running.
  32  * The sequence goes as:
  33  * <ol>
  34  *   <li>Lock candidate datastore on tx construction
  35  *     <ul>
  36  *       <li>Lock has to succeed, if it does not, an attempt to discard changes is made</li>
  37  *       <li>Discard changes has to succeed</li>
  38  *       <li>If discard is successful, lock is reattempted</li>
  39  *       <li>Second lock attempt has to succeed</li>
  40  *     </ul>
  41  *   </li>
  42  *   <li>Edit-config in candidate N times
  43  *     <ul>
  44  *       <li>If any issue occurs during edit,
  45  *       datastore is discarded using discard-changes rpc, unlocked and an exception is thrown async</li>
  46  *     </ul>
  47  *   </li>
  48  *   <li>Commit and Unlock candidate datastore async</li>
  49  * </ol>
  50  */
  51 public class WriteCandidateTx extends AbstractWriteTx {
  52
  53     private static final Logger LOG  = LoggerFactory.getLogger(WriteCandidateTx.class);
  54
  55     public WriteCandidateTx(final RemoteDeviceId id, final NetconfBaseOps rpc, final boolean rollbackSupport) {
  56         super(rpc, id, rollbackSupport);
  57     }
  58
  59     @Override
  60     protected synchronized void init() {
  61         LOG.trace("{}: Initializing {} transaction", id, getClass().getSimpleName());
  62         lock();
  63     }
  64
  65     private void lock() {
  66         final FutureCallback<DOMRpcResult> lockCandidateCallback = new FutureCallback<DOMRpcResult>() {
  67             @Override
  68             public void onSuccess(@Nonnull final DOMRpcResult result) {
  69                 if (isSuccess(result)) {
  70                     if (LOG.isTraceEnabled()) {
  71                         LOG.trace("Lock candidate successful");
  72                     }
  73                 } else {
  74                     LOG.warn("{}: lock candidate invoked unsuccessfully: {}", id, result.getErrors());
  75                 }
  76             }
  77
  78             @Override
  79             public void onFailure(final Throwable throwable) {
  80                 LOG.warn("Lock candidate operation failed. {}", throwable);
  81                 discardChanges();
  82             }
  83         };
  84         resultsFutures.add(netOps.lockCandidate(lockCandidateCallback));
  85     }
  86
  87     @Override
  88     protected void cleanup() {
  89         discardChanges();
  90         cleanupOnSuccess();
  91     }
  92
  93     /**
  94      * This has to be non blocking since it is called from a callback on commit
  95      * and its netty threadpool that is really sensitive to blocking calls.
  96      */
  97     private void discardChanges() {
  98         netOps.discardChanges(new NetconfRpcFutureCallback("Discarding candidate", id));
  99     }
 100
 101     @Override
 102     public synchronized ListenableFuture<RpcResult<Void>> performCommit() {
 103         resultsFutures.add(netOps.commit(new NetconfRpcFutureCallback("Commit", id)));
 104         final ListenableFuture<RpcResult<Void>> txResult = resultsToTxStatus();
 105
 106         Futures.addCallback(txResult, new FutureCallback<RpcResult<Void>>() {
 107             @Override
 108             public void onSuccess(@Nullable final RpcResult<Void> result) {
 109                 cleanupOnSuccess();
 110             }
 111
 112             @Override
 113             public void onFailure(final Throwable throwable) {
 114                 // TODO If lock is cause of this failure cleanup will issue warning log
 115                 // cleanup is trying to do unlock, but this will fail
 116                 cleanup();
 117             }
 118         }, MoreExecutors.directExecutor());
 119
 120         return txResult;
 121     }
 122
 123     protected void cleanupOnSuccess() {
 124         unlock();
 125     }
 126
 127     @Override
 128     protected void editConfig(final YangInstanceIdentifier path,
 129                               final Optional<NormalizedNode<?, ?>> data,
 130                               final DataContainerChild<?, ?> editStructure,
 131                               final Optional<ModifyAction> defaultOperation,
 132                               final String operation) {
 133
 134         final NetconfRpcFutureCallback editConfigCallback = new NetconfRpcFutureCallback("Edit candidate", id);
 135
 136         if (defaultOperation.isPresent()) {
 137             resultsFutures.add(netOps.editConfigCandidate(
 138                     editConfigCallback, editStructure, defaultOperation.get(), rollbackSupport));
 139         } else {
 140             resultsFutures.add(netOps.editConfigCandidate(editConfigCallback, editStructure, rollbackSupport));
 141         }
 142     }
 143
 144     /**
 145      * This has to be non blocking since it is called from a callback on commit
 146      * and its netty threadpool that is really sensitive to blocking calls.
 147      */
 148     private void unlock() {
 149         netOps.unlockCandidate(new NetconfRpcFutureCallback("Unlock candidate", id));
 150     }
 151
 152 }