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 com.google.common.base.MoreObjects;
11 import com.google.common.base.Preconditions;
12 import java.util.Optional;
13 import java.util.SortedSet;
14 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
16 import org.opendaylight.yangtools.concepts.Identifiable;
17 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
18 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
19 import org.slf4j.Logger;
20 import org.slf4j.LoggerFactory;
23 * A transaction chain attached to a Shard. This class is NOT thread-safe.
25 final class ShardDataTreeTransactionChain extends ShardDataTreeTransactionParent
26 implements Identifiable<LocalHistoryIdentifier> {
28 private static final Logger LOG = LoggerFactory.getLogger(ShardDataTreeTransactionChain.class);
29 private final LocalHistoryIdentifier chainId;
30 private final ShardDataTree dataTree;
32 private ReadWriteShardDataTreeTransaction previousTx;
33 private ReadWriteShardDataTreeTransaction openTransaction;
34 private boolean closed;
36 ShardDataTreeTransactionChain(final LocalHistoryIdentifier localHistoryIdentifier, final ShardDataTree dataTree) {
37 this.chainId = Preconditions.checkNotNull(localHistoryIdentifier);
38 this.dataTree = Preconditions.checkNotNull(dataTree);
41 private DataTreeSnapshot getSnapshot() {
42 Preconditions.checkState(!closed, "TransactionChain %s has been closed", this);
43 Preconditions.checkState(openTransaction == null, "Transaction %s is open", openTransaction);
45 if (previousTx == null) {
46 LOG.debug("Opening an unchained snapshot in {}", chainId);
47 return dataTree.takeSnapshot();
50 LOG.debug("Reusing a chained snapshot in {}", chainId);
51 return previousTx.getSnapshot();
54 ReadOnlyShardDataTreeTransaction newReadOnlyTransaction(final TransactionIdentifier txId) {
55 final DataTreeSnapshot snapshot = getSnapshot();
56 LOG.debug("Allocated read-only transaction {} snapshot {}", txId, snapshot);
58 return new ReadOnlyShardDataTreeTransaction(this, txId, snapshot);
61 ReadWriteShardDataTreeTransaction newReadWriteTransaction(final TransactionIdentifier txId) {
62 final DataTreeSnapshot snapshot = getSnapshot();
63 LOG.debug("Allocated read-write transaction {} snapshot {}", txId, snapshot);
65 openTransaction = new ReadWriteShardDataTreeTransaction(this, txId, snapshot.newModification());
66 return openTransaction;
71 LOG.debug("Closing chain {}", chainId);
75 void abortFromTransactionActor(final AbstractShardDataTreeTransaction<?> transaction) {
76 if (transaction instanceof ReadWriteShardDataTreeTransaction) {
77 Preconditions.checkState(openTransaction != null,
78 "Attempted to abort transaction %s while none is outstanding", transaction);
79 LOG.debug("Aborted open transaction {}", transaction);
80 openTransaction = null;
85 void abortTransaction(final AbstractShardDataTreeTransaction<?> transaction, final Runnable callback) {
86 abortFromTransactionActor(transaction);
87 dataTree.abortTransaction(transaction, callback);
91 ShardDataTreeCohort finishTransaction(final ReadWriteShardDataTreeTransaction transaction,
92 final Optional<SortedSet<String>> participatingShardNames) {
93 Preconditions.checkState(openTransaction != null,
94 "Attempted to finish transaction %s while none is outstanding", transaction);
96 // dataTree is finalizing ready the transaction, we just record it for the next
97 // transaction in chain
98 final ShardDataTreeCohort delegate = dataTree.finishTransaction(transaction, participatingShardNames);
99 openTransaction = null;
100 previousTx = transaction;
101 LOG.debug("Committing transaction {}", transaction);
103 return new ChainedCommitCohort(this, transaction, delegate);
107 public String toString() {
108 return MoreObjects.toStringHelper(this).add("id", chainId).toString();
111 void clearTransaction(final ReadWriteShardDataTreeTransaction transaction) {
112 if (transaction.equals(previousTx)) {
118 public LocalHistoryIdentifier getIdentifier() {
123 ShardDataTreeCohort createFailedCohort(final TransactionIdentifier txId, final DataTreeModification mod,
124 final Exception failure) {
125 return dataTree.createFailedCohort(txId, mod, failure);
129 ShardDataTreeCohort createReadyCohort(final TransactionIdentifier txId, final DataTreeModification mod,
130 final Optional<SortedSet<String>> participatingShardNames) {
131 return dataTree.createReadyCohort(txId, mod, participatingShardNames);