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.base.Function;
  12 import com.google.common.base.Optional;
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.util.concurrent.CheckedFuture;
  15 import com.google.common.util.concurrent.Futures;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17 import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult;
  20 import org.opendaylight.netconf.api.NetconfDocumentedException;
  21 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfBaseOps;
  22 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfRpcFutureCallback;
  23 import org.opendaylight.netconf.sal.connect.util.RemoteDeviceId;
  24 import org.opendaylight.yangtools.yang.common.RpcError;
  25 import org.opendaylight.yangtools.yang.common.RpcResult;
  26 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  27 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  29 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 /**
  35  * Tx implementation for netconf devices that support only candidate datastore and no writable running
  36  * The sequence goes as:
  37  * <ol>
  38  *   <li>Lock candidate datastore on tx construction
  39  *     <ul>
  40  *       <li>Lock has to succeed, if it does not, an attempt to discard changes is made</li>
  41  *       <li>Discard changes has to succeed</li>
  42  *       <li>If discard is successful, lock is reattempted</li>
  43  *       <li>Second lock attempt has to succeed</li>
  44  *     </ul>
  45  *   </li>
  46  *   <li>Edit-config in candidate N times
  47  *     <ul>
  48  *       <li>If any issue occurs during edit, datastore is discarded using discard-changes rpc, unlocked and an exception is thrown async</li>
  49  *     </ul>
  50  *   </li>
  51  *   <li>Commit and Unlock candidate datastore async</li>
  52  * </ol>
  53  */
  54 public class WriteCandidateTx extends AbstractWriteTx {
  55
  56     private static final Logger LOG  = LoggerFactory.getLogger(WriteCandidateTx.class);
  57
  58     private static final Function<DOMRpcResult, RpcResult<TransactionStatus>> RPC_RESULT_TO_TX_STATUS = new Function<DOMRpcResult, RpcResult<TransactionStatus>>() {
  59         @Override
  60         public RpcResult<TransactionStatus> apply(final DOMRpcResult input) {
  61             if (isSuccess(input)) {
  62                 return RpcResultBuilder.success(TransactionStatus.COMMITED).build();
  63             } else {
  64                 final RpcResultBuilder<TransactionStatus> failed = RpcResultBuilder.failed();
  65                 for (final RpcError rpcError : input.getErrors()) {
  66                     failed.withError(rpcError.getErrorType(), rpcError.getTag(), rpcError.getMessage(),
  67                             rpcError.getApplicationTag(), rpcError.getInfo(), rpcError.getCause());
  68                 }
  69                 return failed.build();
  70             }
  71         }
  72     };
  73
  74     public WriteCandidateTx(final RemoteDeviceId id, final NetconfBaseOps rpc, final boolean rollbackSupport) {
  75         super(rpc, id, rollbackSupport);
  76     }
  77
  78     @Override
  79     protected synchronized void init() {
  80         LOG.trace("{}: Initializing {} transaction", id, getClass().getSimpleName());
  81
  82         try {
  83             lock();
  84         } catch (final NetconfDocumentedException e) {
  85             try {
  86                 LOG.warn("{}: Failed to lock candidate, attempting discard changes", id);
  87                 discardChanges();
  88                 LOG.warn("{}: Changes discarded successfully, attempting lock", id);
  89                 lock();
  90             } catch (final NetconfDocumentedException secondE) {
  91                 LOG.error("{}: Failed to prepare candidate. Failed to initialize transaction", id, secondE);
  92                 throw new RuntimeException(id + ": Failed to prepare candidate. Failed to initialize transaction", secondE);
  93             }
  94         }
  95     }
  96
  97     private void lock() throws NetconfDocumentedException {
  98         try {
  99             invokeBlocking("Lock candidate", new Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>>() {
 100                 @Override
 101                 public ListenableFuture<DOMRpcResult> apply(final NetconfBaseOps input) {
 102                     return input.lockCandidate(new NetconfRpcFutureCallback("Lock candidate", id));
 103                 }
 104             });
 105         } catch (final NetconfDocumentedException e) {
 106             LOG.warn("{}: Failed to lock candidate", id, e);
 107             throw e;
 108         }
 109     }
 110
 111     @Override
 112     protected void cleanup() {
 113         discardChanges();
 114         cleanupOnSuccess();
 115     }
 116
 117     @Override
 118     protected void handleEditException(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data, final NetconfDocumentedException e, final String editType) {
 119         LOG.warn("{}: Error {} data to (candidate){}, data: {}, canceling", id, editType, path, data, e);
 120         cancel();
 121         throw new RuntimeException(id + ": Error while " + editType + ": (candidate)" + path, e);
 122     }
 123
 124     @Override
 125     protected void handleDeleteException(final YangInstanceIdentifier path, final NetconfDocumentedException e) {
 126         LOG.warn("{}: Error deleting data (candidate){}, canceling", id, path, e);
 127         cancel();
 128         throw new RuntimeException(id + ": Error while deleting (candidate)" + path, e);
 129     }
 130
 131     @Override
 132     public synchronized CheckedFuture<Void, TransactionCommitFailedException> submit() {
 133         final ListenableFuture<Void> commitFutureAsVoid = Futures.transform(commit(), new Function<RpcResult<TransactionStatus>, Void>() {
 134             @Override
 135             public Void apply(final RpcResult<TransactionStatus> input) {
 136                 Preconditions.checkArgument(input.isSuccessful() && input.getErrors().isEmpty(), "Submit failed with errors: %s", input.getErrors());
 137                 return null;
 138             }
 139         });
 140
 141         return Futures.makeChecked(commitFutureAsVoid, new Function<Exception, TransactionCommitFailedException>() {
 142             @Override
 143             public TransactionCommitFailedException apply(final Exception input) {
 144                 return new TransactionCommitFailedException("Submit of transaction " + getIdentifier() + " failed", input);
 145             }
 146         });
 147     }
 148
 149     /**
 150      * This has to be non blocking since it is called from a callback on commit and its netty threadpool that is really sensitive to blocking calls
 151      */
 152     private void discardChanges() {
 153         netOps.discardChanges(new NetconfRpcFutureCallback("Discarding candidate", id));
 154     }
 155
 156     @Override
 157     public synchronized ListenableFuture<RpcResult<TransactionStatus>> performCommit() {
 158         final ListenableFuture<DOMRpcResult> rpcResult = netOps.commit(new NetconfRpcFutureCallback("Commit", id) {
 159             @Override
 160             public void onSuccess(final DOMRpcResult result) {
 161                 super.onSuccess(result);
 162                 LOG.debug("{}: Write successful, transaction: {}. Unlocking", id, getIdentifier());
 163                 cleanupOnSuccess();
 164             }
 165
 166             @Override
 167             protected void onUnsuccess(final DOMRpcResult result) {
 168                 LOG.error("{}: Write failed, transaction {}, discarding changes, unlocking: {}", id, getIdentifier(), result.getErrors());
 169                 cleanup();
 170             }
 171
 172             @Override
 173             public void onFailure(final Throwable t) {
 174                 LOG.error("{}: Write failed, transaction {}, discarding changes, unlocking", id, getIdentifier(), t);
 175                 cleanup();
 176             }
 177         });
 178
 179         return Futures.transform(rpcResult, RPC_RESULT_TO_TX_STATUS);
 180     }
 181
 182     protected void cleanupOnSuccess() {
 183         unlock();
 184     }
 185
 186     @Override
 187     protected void editConfig(final DataContainerChild<?, ?> editStructure, final Optional<ModifyAction> defaultOperation) throws NetconfDocumentedException {
 188         invokeBlocking("Edit candidate", new Function<NetconfBaseOps, ListenableFuture<DOMRpcResult>>() {
 189             @Override
 190             public ListenableFuture<DOMRpcResult> apply(final NetconfBaseOps input) {
 191                     return defaultOperation.isPresent()
 192                             ? input.editConfigCandidate(new NetconfRpcFutureCallback("Edit candidate", id), editStructure, defaultOperation.get(),
 193                             rollbackSupport)
 194                             : input.editConfigCandidate(new NetconfRpcFutureCallback("Edit candidate", id), editStructure,
 195                             rollbackSupport);
 196             }
 197         });
 198     }
 199
 200     /**
 201      * This has to be non blocking since it is called from a callback on commit and its netty threadpool that is really sensitive to blocking calls
 202      */
 203     private void unlock() {
 204         netOps.unlockCandidate(new NetconfRpcFutureCallback("Unlock candidate", id));
 205     }
 206
 207 }