opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/LocalTransactionChain.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 package org.opendaylight.controller.cluster.datastore;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import akka.actor.ActorSelection;
  14 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  15 import org.opendaylight.mdsal.dom.spi.store.AbstractSnapshotBackedTransactionChain;
  16 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadTransaction;
  17 import org.opendaylight.mdsal.dom.spi.store.DOMStoreReadWriteTransaction;
  18 import org.opendaylight.mdsal.dom.spi.store.DOMStoreThreePhaseCommitCohort;
  19 import org.opendaylight.mdsal.dom.spi.store.DOMStoreWriteTransaction;
  20 import org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction;
  21 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
  22 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
  23 import org.opendaylight.yangtools.yang.data.tree.api.ReadOnlyDataTree;
  24
  25 /**
  26  * Transaction chain instantiated on top of a locally-available DataTree. It does not instantiate
  27  * a transaction in the leader and rather chains transactions on top of themselves.
  28  */
  29 final class LocalTransactionChain extends AbstractSnapshotBackedTransactionChain<TransactionIdentifier>
  30         implements LocalTransactionFactory {
  31     private static final Throwable ABORTED = new Throwable("Transaction aborted");
  32     private final TransactionChainProxy parent;
  33     private final ActorSelection leader;
  34     private final ReadOnlyDataTree tree;
  35
  36     LocalTransactionChain(final TransactionChainProxy parent, final ActorSelection leader,
  37             final ReadOnlyDataTree tree) {
  38         this.parent = requireNonNull(parent);
  39         this.leader = requireNonNull(leader);
  40         this.tree = requireNonNull(tree);
  41     }
  42
  43     ReadOnlyDataTree getDataTree() {
  44         return tree;
  45     }
  46
  47     @Override
  48     protected TransactionIdentifier nextTransactionIdentifier() {
  49         throw new UnsupportedOperationException();
  50     }
  51
  52     @Override
  53     protected boolean getDebugTransactions() {
  54         return false;
  55     }
  56
  57     @Override
  58     protected DataTreeSnapshot takeSnapshot() {
  59         return tree.takeSnapshot();
  60     }
  61
  62     @Override
  63     protected DOMStoreThreePhaseCommitCohort createCohort(
  64             final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
  65             final DataTreeModification modification,
  66             final Exception operationError) {
  67         return new LocalChainThreePhaseCommitCohort(transaction, modification, operationError);
  68     }
  69
  70     @Override
  71     public DOMStoreReadTransaction newReadOnlyTransaction(final TransactionIdentifier identifier) {
  72         return super.newReadOnlyTransaction(identifier);
  73     }
  74
  75     @Override
  76     public DOMStoreReadWriteTransaction newReadWriteTransaction(final TransactionIdentifier identifier) {
  77         return super.newReadWriteTransaction(identifier);
  78     }
  79
  80     @Override
  81     public DOMStoreWriteTransaction newWriteOnlyTransaction(final TransactionIdentifier identifier) {
  82         return super.newWriteOnlyTransaction(identifier);
  83     }
  84
  85     @SuppressWarnings({"unchecked", "checkstyle:IllegalCatch"})
  86     @Override
  87     public LocalThreePhaseCommitCohort onTransactionReady(final DOMStoreWriteTransaction tx,
  88             final Exception operationError) {
  89         checkArgument(tx instanceof SnapshotBackedWriteTransaction);
  90         if (operationError != null) {
  91             return new LocalChainThreePhaseCommitCohort((SnapshotBackedWriteTransaction<TransactionIdentifier>)tx,
  92                     operationError);
  93         }
  94
  95         try {
  96             return (LocalThreePhaseCommitCohort) tx.ready();
  97         } catch (Exception e) {
  98             // Unfortunately we need to cast to SnapshotBackedWriteTransaction here as it's required by
  99             // LocalThreePhaseCommitCohort and the base class.
 100             return new LocalChainThreePhaseCommitCohort((SnapshotBackedWriteTransaction<TransactionIdentifier>)tx, e);
 101         }
 102     }
 103
 104     private class LocalChainThreePhaseCommitCohort extends LocalThreePhaseCommitCohort {
 105
 106         protected LocalChainThreePhaseCommitCohort(
 107                 final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
 108                 final DataTreeModification modification, final Exception operationError) {
 109             super(parent.getActorUtils(), leader, transaction, modification, operationError);
 110         }
 111
 112         protected LocalChainThreePhaseCommitCohort(
 113                 final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
 114                 final Exception operationError) {
 115             super(parent.getActorUtils(), leader, transaction, operationError);
 116         }
 117
 118         @Override
 119         protected void transactionAborted(final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
 120             onTransactionFailed(transaction, ABORTED);
 121         }
 122
 123         @Override
 124         protected void transactionCommitted(final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
 125             onTransactionCommited(transaction);
 126         }
 127     }
 128 }