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 static com.google.common.base.Preconditions.checkState;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.base.MoreObjects;
14 import java.util.Optional;
15 import java.util.SortedSet;
16 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
17 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
18 import org.opendaylight.yangtools.concepts.Identifiable;
19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeSnapshot;
21 import org.slf4j.Logger;
22 import org.slf4j.LoggerFactory;
25 * A transaction chain attached to a Shard. This class is NOT thread-safe.
27 final class ShardDataTreeTransactionChain extends ShardDataTreeTransactionParent
28 implements Identifiable<LocalHistoryIdentifier> {
30 private static final Logger LOG = LoggerFactory.getLogger(ShardDataTreeTransactionChain.class);
31 private final LocalHistoryIdentifier chainId;
32 private final ShardDataTree dataTree;
34 private ReadWriteShardDataTreeTransaction previousTx;
35 private ReadWriteShardDataTreeTransaction openTransaction;
36 private boolean closed;
38 ShardDataTreeTransactionChain(final LocalHistoryIdentifier localHistoryIdentifier, final ShardDataTree dataTree) {
39 this.chainId = requireNonNull(localHistoryIdentifier);
40 this.dataTree = requireNonNull(dataTree);
43 private DataTreeSnapshot getSnapshot() {
44 checkState(!closed, "TransactionChain %s has been closed", this);
45 checkState(openTransaction == null, "Transaction %s is open", openTransaction);
47 if (previousTx == null) {
48 LOG.debug("Opening an unchained snapshot in {}", chainId);
49 return dataTree.takeSnapshot();
52 LOG.debug("Reusing a chained snapshot in {}", chainId);
53 return previousTx.getSnapshot();
56 ReadOnlyShardDataTreeTransaction newReadOnlyTransaction(final TransactionIdentifier txId) {
57 final DataTreeSnapshot snapshot = getSnapshot();
58 LOG.debug("Allocated read-only transaction {} snapshot {}", txId, snapshot);
60 return new ReadOnlyShardDataTreeTransaction(this, txId, snapshot);
63 ReadWriteShardDataTreeTransaction newReadWriteTransaction(final TransactionIdentifier txId) {
64 final DataTreeSnapshot snapshot = getSnapshot();
65 LOG.debug("Allocated read-write transaction {} snapshot {}", txId, snapshot);
67 openTransaction = new ReadWriteShardDataTreeTransaction(this, txId, snapshot.newModification());
68 return openTransaction;
73 LOG.debug("Closing chain {}", chainId);
77 void abortFromTransactionActor(final AbstractShardDataTreeTransaction<?> transaction) {
78 if (transaction instanceof ReadWriteShardDataTreeTransaction) {
79 checkState(openTransaction != null, "Attempted to abort transaction %s while none is outstanding",
81 LOG.debug("Aborted open transaction {}", transaction);
82 openTransaction = null;
87 void abortTransaction(final AbstractShardDataTreeTransaction<?> transaction, final Runnable callback) {
88 abortFromTransactionActor(transaction);
89 dataTree.abortTransaction(transaction, callback);
93 ShardDataTreeCohort finishTransaction(final ReadWriteShardDataTreeTransaction transaction,
94 final Optional<SortedSet<String>> participatingShardNames) {
95 checkState(openTransaction != null, "Attempted to finish transaction %s while none is outstanding",
98 // dataTree is finalizing ready the transaction, we just record it for the next
99 // transaction in chain
100 final ShardDataTreeCohort delegate = dataTree.finishTransaction(transaction, participatingShardNames);
101 openTransaction = null;
102 previousTx = transaction;
103 LOG.debug("Committing transaction {}", transaction);
105 return new ChainedCommitCohort(this, transaction, delegate);
109 public String toString() {
110 return MoreObjects.toStringHelper(this).add("id", chainId).toString();
113 void clearTransaction(final ReadWriteShardDataTreeTransaction transaction) {
114 if (transaction.equals(previousTx)) {
120 public LocalHistoryIdentifier getIdentifier() {
125 ShardDataTreeCohort createFailedCohort(final TransactionIdentifier txId, final DataTreeModification mod,
126 final Exception failure) {
127 return dataTree.createFailedCohort(txId, mod, failure);
131 ShardDataTreeCohort createReadyCohort(final TransactionIdentifier txId, final DataTreeModification mod,
132 final Optional<SortedSet<String>> participatingShardNames) {
133 return dataTree.createReadyCohort(txId, mod, participatingShardNames);