2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.controller.cluster.datastore;
10 import akka.actor.ActorSelection;
11 import com.google.common.base.Preconditions;
12 import javax.annotation.Nonnull;
13 import javax.annotation.Nullable;
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.api.schema.tree.DataTree;
22 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
23 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
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.
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 DataTree tree;
36 LocalTransactionChain(final TransactionChainProxy parent, final ActorSelection leader, final DataTree tree) {
37 this.parent = Preconditions.checkNotNull(parent);
38 this.leader = Preconditions.checkNotNull(leader);
39 this.tree = Preconditions.checkNotNull(tree);
42 DataTree getDataTree() {
47 protected TransactionIdentifier nextTransactionIdentifier() {
48 throw new UnsupportedOperationException();
52 protected boolean getDebugTransactions() {
57 protected DataTreeSnapshot takeSnapshot() {
58 return tree.takeSnapshot();
62 protected DOMStoreThreePhaseCommitCohort createCohort(
63 final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
64 final DataTreeModification modification,
65 final Exception operationError) {
66 return new LocalChainThreePhaseCommitCohort(transaction, modification, operationError);
70 public DOMStoreReadTransaction newReadOnlyTransaction(TransactionIdentifier identifier) {
71 return super.newReadOnlyTransaction(identifier);
75 public DOMStoreReadWriteTransaction newReadWriteTransaction(TransactionIdentifier identifier) {
76 return super.newReadWriteTransaction(identifier);
80 public DOMStoreWriteTransaction newWriteOnlyTransaction(TransactionIdentifier identifier) {
81 return super.newWriteOnlyTransaction(identifier);
84 @SuppressWarnings({"unchecked", "checkstyle:IllegalCatch"})
86 public LocalThreePhaseCommitCohort onTransactionReady(@Nonnull DOMStoreWriteTransaction tx,
87 @Nullable Exception operationError) {
88 Preconditions.checkArgument(tx instanceof SnapshotBackedWriteTransaction);
89 if (operationError != null) {
90 return new LocalChainThreePhaseCommitCohort((SnapshotBackedWriteTransaction<TransactionIdentifier>)tx,
95 return (LocalThreePhaseCommitCohort) tx.ready();
96 } catch (Exception e) {
97 // Unfortunately we need to cast to SnapshotBackedWriteTransaction here as it's required by
98 // LocalThreePhaseCommitCohort and the base class.
99 return new LocalChainThreePhaseCommitCohort((SnapshotBackedWriteTransaction<TransactionIdentifier>)tx, e);
103 private class LocalChainThreePhaseCommitCohort extends LocalThreePhaseCommitCohort {
105 protected LocalChainThreePhaseCommitCohort(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
106 DataTreeModification modification, Exception operationError) {
107 super(parent.getActorContext(), leader, transaction, modification, operationError);
110 protected LocalChainThreePhaseCommitCohort(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction,
111 Exception operationError) {
112 super(parent.getActorContext(), leader, transaction, operationError);
116 protected void transactionAborted(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
117 onTransactionFailed(transaction, ABORTED);
121 protected void transactionCommitted(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
122 onTransactionCommited(transaction);