2 * Copyright (c) 2016 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.databroker.actors.dds;
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.base.Verify;
13 import com.google.common.util.concurrent.CheckedFuture;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import com.google.common.util.concurrent.SettableFuture;
16 import org.opendaylight.controller.cluster.access.commands.TransactionAbortRequest;
17 import org.opendaylight.controller.cluster.access.commands.TransactionAbortSuccess;
18 import org.opendaylight.controller.cluster.access.commands.TransactionCanCommitSuccess;
19 import org.opendaylight.controller.cluster.access.commands.TransactionCommitSuccess;
20 import org.opendaylight.controller.cluster.access.commands.TransactionDoCommitRequest;
21 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitRequest;
22 import org.opendaylight.controller.cluster.access.commands.TransactionPreCommitSuccess;
23 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
24 import org.opendaylight.controller.cluster.access.concepts.LocalHistoryIdentifier;
25 import org.opendaylight.controller.cluster.access.concepts.RequestFailure;
26 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
27 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
28 import org.opendaylight.yangtools.concepts.Identifiable;
29 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
34 * Class translating transaction operations towards a particular backend shard.
36 * This class is not safe to access from multiple application threads, as is usual for transactions. Internal state
37 * transitions coming from interactions with backend are expected to be thread-safe.
39 * This class interacts with the queueing mechanism in ClientActorBehavior, hence once we arrive at a decision
40 * to use either a local or remote implementation, we are stuck with it. We can re-evaluate on the next transaction.
42 * @author Robert Varga
44 abstract class AbstractProxyTransaction implements Identifiable<TransactionIdentifier> {
45 private final DistributedDataStoreClientBehavior client;
47 private long sequence;
48 private boolean sealed;
50 AbstractProxyTransaction(final DistributedDataStoreClientBehavior client) {
51 this.client = Preconditions.checkNotNull(client);
55 * Instantiate a new tracker for a transaction. This method bases its decision on which implementation to use
56 * based on provided {@link ShardBackendInfo}. If no information is present, it will choose the remote
57 * implementation, which is fine, as the queueing logic in ClientActorBehavior will hold on to the requests until
58 * the backend is located.
60 * @param client Client behavior
61 * @param historyId Local history identifier
62 * @param transactionId Transaction identifier
63 * @param backend Optional backend identifier
64 * @return A new state tracker
66 static AbstractProxyTransaction create(final DistributedDataStoreClientBehavior client,
67 final LocalHistoryIdentifier historyId, final long transactionId,
68 final java.util.Optional<ShardBackendInfo> backend) {
70 final java.util.Optional<DataTree> dataTree = backend.flatMap(t -> t.getDataTree());
71 final TransactionIdentifier identifier = new TransactionIdentifier(historyId, transactionId);
72 if (dataTree.isPresent()) {
73 return new LocalProxyTransaction(client, identifier, dataTree.get().takeSnapshot());
75 return new RemoteProxyTransaction(client, identifier);
79 final DistributedDataStoreClientBehavior client() {
83 final long nextSequence() {
87 final void delete(final YangInstanceIdentifier path) {
92 final void merge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
97 final void write(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data) {
102 final CheckedFuture<Boolean, ReadFailedException> exists(final YangInstanceIdentifier path) {
104 return doExists(path);
107 final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(final YangInstanceIdentifier path) {
113 * Seal this transaction before it is either
121 private void checkSealed() {
122 Preconditions.checkState(sealed, "Transaction %s has not been sealed yet", getIdentifier());
126 * Abort this transaction. This is invoked only for read-only transactions and will result in an explicit message
127 * being sent to the backend.
135 * Commit this transaction, possibly in a coordinated fashion.
137 * @param coordinated True if this transaction should be coordinated across multiple participants.
138 * @return Future completion
140 final ListenableFuture<Boolean> directCommit() {
143 final SettableFuture<Boolean> ret = SettableFuture.create();
144 client().sendRequest(nextSequence(), Verify.verifyNotNull(doCommit(false)), t -> {
145 if (t instanceof TransactionCommitSuccess) {
146 ret.set(Boolean.TRUE);
147 } else if (t instanceof RequestFailure) {
148 ret.setException(((RequestFailure<?, ?>) t).getCause());
150 ret.setException(new IllegalStateException("Unhandled response " + t.getClass()));
156 void abort(final VotingFuture<Void> ret) {
159 client.sendRequest(nextSequence(), new TransactionAbortRequest(getIdentifier(), client().self()), t -> {
160 if (t instanceof TransactionAbortSuccess) {
162 } else if (t instanceof RequestFailure) {
163 ret.voteNo(((RequestFailure<?, ?>) t).getCause());
165 ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
170 void canCommit(final VotingFuture<?> ret) {
173 client.sendRequest(nextSequence(), Verify.verifyNotNull(doCommit(true)), t -> {
174 if (t instanceof TransactionCanCommitSuccess) {
176 } else if (t instanceof RequestFailure) {
177 ret.voteNo(((RequestFailure<?, ?>) t).getCause());
179 ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
184 void preCommit(final VotingFuture<?> ret) {
187 client.sendRequest(nextSequence(), new TransactionPreCommitRequest(getIdentifier(), client().self()), t-> {
188 if (t instanceof TransactionPreCommitSuccess) {
190 } else if (t instanceof RequestFailure) {
191 ret.voteNo(((RequestFailure<?, ?>) t).getCause());
193 ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
198 void doCommit(final VotingFuture<?> ret) {
201 client.sendRequest(nextSequence(), new TransactionDoCommitRequest(getIdentifier(), client().self()), t-> {
202 if (t instanceof TransactionCommitSuccess) {
204 } else if (t instanceof RequestFailure) {
205 ret.voteNo(((RequestFailure<?, ?>) t).getCause());
207 ret.voteNo(new IllegalStateException("Unhandled response " + t.getClass()));
212 abstract void doDelete(final YangInstanceIdentifier path);
214 abstract void doMerge(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data);
216 abstract void doWrite(final YangInstanceIdentifier path, final NormalizedNode<?, ?> data);
218 abstract CheckedFuture<Boolean, ReadFailedException> doExists(final YangInstanceIdentifier path);
220 abstract CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> doRead(final YangInstanceIdentifier path);
222 abstract void doSeal();
224 abstract void doAbort();
226 abstract TransactionRequest<?> doCommit(boolean coordinated);