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 static java.util.Objects.requireNonNull;
12 import com.google.common.util.concurrent.FluentFuture;
13 import java.util.Optional;
14 import java.util.function.Consumer;
15 import org.eclipse.jdt.annotation.NonNull;
16 import org.eclipse.jdt.annotation.Nullable;
17 import org.opendaylight.controller.cluster.access.commands.AbortLocalTransactionRequest;
18 import org.opendaylight.controller.cluster.access.commands.AbstractLocalTransactionRequest;
19 import org.opendaylight.controller.cluster.access.commands.CommitLocalTransactionRequest;
20 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionRequest;
21 import org.opendaylight.controller.cluster.access.commands.ExistsTransactionSuccess;
22 import org.opendaylight.controller.cluster.access.commands.IncrementTransactionSequenceRequest;
23 import org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest;
24 import org.opendaylight.controller.cluster.access.commands.ReadTransactionRequest;
25 import org.opendaylight.controller.cluster.access.commands.ReadTransactionSuccess;
26 import org.opendaylight.controller.cluster.access.commands.TransactionPurgeRequest;
27 import org.opendaylight.controller.cluster.access.commands.TransactionRequest;
28 import org.opendaylight.controller.cluster.access.concepts.Response;
29 import org.opendaylight.controller.cluster.access.concepts.RuntimeRequestException;
30 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
31 import org.opendaylight.controller.cluster.datastore.util.AbstractDataTreeModificationCursor;
32 import org.opendaylight.mdsal.common.api.ReadFailedException;
33 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
34 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
35 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
36 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
37 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeModification;
38 import org.opendaylight.yangtools.yang.data.tree.api.DataTreeSnapshot;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * An {@link AbstractProxyTransaction} for dispatching a transaction towards a shard leader which is co-located with
44 * the client instance. This class is NOT thread-safe.
47 * It requires a {@link DataTreeSnapshot}, which is used to instantiated a new {@link DataTreeModification}. Operations
48 * are then performed on this modification and once the transaction is submitted, the modification is sent to the shard
52 * This class is not thread-safe as usual with transactions. Since it does not interact with the backend until the
53 * transaction is submitted, at which point this class gets out of the picture, this is not a cause for concern.
55 abstract sealed class LocalProxyTransaction extends AbstractProxyTransaction
56 permits LocalReadOnlyProxyTransaction, LocalReadWriteProxyTransaction {
57 private static final Logger LOG = LoggerFactory.getLogger(LocalProxyTransaction.class);
59 private final @NonNull TransactionIdentifier identifier;
61 LocalProxyTransaction(final ProxyHistory parent, final TransactionIdentifier identifier, final boolean isDone) {
62 super(parent, isDone);
63 this.identifier = requireNonNull(identifier);
67 public final TransactionIdentifier getIdentifier() {
71 abstract @NonNull DataTreeSnapshot readOnlyView();
73 abstract void applyForwardedModifyTransactionRequest(ModifyTransactionRequest request,
74 @Nullable Consumer<Response<?, ?>> callback);
76 abstract void replayModifyTransactionRequest(ModifyTransactionRequest request,
77 @Nullable Consumer<Response<?, ?>> callback, long enqueuedTicks);
80 FluentFuture<Boolean> doExists(final YangInstanceIdentifier path) {
83 result = readOnlyView().readNode(path).isPresent();
84 } catch (FailedDataTreeModificationException e) {
85 return FluentFutures.immediateFailedFluentFuture(ReadFailedException.MAPPER.apply(e));
87 return FluentFutures.immediateBooleanFluentFuture(result);
91 FluentFuture<Optional<NormalizedNode>> doRead(final YangInstanceIdentifier path) {
92 final Optional<NormalizedNode> result;
94 result = readOnlyView().readNode(path);
95 } catch (FailedDataTreeModificationException e) {
96 return FluentFutures.immediateFailedFluentFuture(ReadFailedException.MAPPER.apply(e));
98 return FluentFutures.immediateFluentFuture(result);
102 final AbortLocalTransactionRequest abortRequest() {
103 return new AbortLocalTransactionRequest(identifier, localActor());
107 void handleReplayedLocalRequest(final AbstractLocalTransactionRequest<?> request,
108 final Consumer<Response<?, ?>> callback, final long enqueuedTicks) {
109 if (request instanceof AbortLocalTransactionRequest) {
110 enqueueAbort(request, callback, enqueuedTicks);
112 throw unhandledRequest(request);
117 void handleReplayedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
118 final long enqueuedTicks) {
119 if (request instanceof ModifyTransactionRequest) {
120 replayModifyTransactionRequest((ModifyTransactionRequest) request, callback, enqueuedTicks);
121 } else if (handleReadRequest(request, callback)) {
123 } else if (request instanceof TransactionPurgeRequest) {
124 enqueuePurge(callback, enqueuedTicks);
125 } else if (request instanceof IncrementTransactionSequenceRequest) {
126 // Local transactions do not have non-replayable requests which would be visible to the backend,
127 // hence we can skip sequence increments.
128 LOG.debug("Not replaying {}", request);
130 throw unhandledRequest(request);
135 * Remote-to-local equivalent of {@link #handleReplayedRemoteRequest(TransactionRequest, Consumer, long)},
136 * except it is invoked in the forwarding path from
137 * {@link RemoteProxyTransaction#forwardToLocal(LocalProxyTransaction, TransactionRequest, Consumer)}.
139 * @param request Forwarded request
140 * @param callback Callback to be invoked once the request completes
142 void handleForwardedRemoteRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
143 if (request instanceof ModifyTransactionRequest) {
144 applyForwardedModifyTransactionRequest((ModifyTransactionRequest) request, callback);
145 } else if (handleReadRequest(request, callback)) {
147 } else if (request instanceof TransactionPurgeRequest) {
148 enqueuePurge(callback);
150 throw unhandledRequest(request);
154 @NonNull Response<?, ?> handleExistsRequest(final @NonNull DataTreeSnapshot snapshot,
155 final @NonNull ExistsTransactionRequest request) {
157 return new ExistsTransactionSuccess(request.getTarget(), request.getSequence(),
158 snapshot.readNode(request.getPath()).isPresent());
159 } catch (FailedDataTreeModificationException e) {
160 return request.toRequestFailure(new RuntimeRequestException("Failed to access data",
161 ReadFailedException.MAPPER.apply(e)));
165 @NonNull Response<?, ?> handleReadRequest(final @NonNull DataTreeSnapshot snapshot,
166 final @NonNull ReadTransactionRequest request) {
168 return new ReadTransactionSuccess(request.getTarget(), request.getSequence(),
169 snapshot.readNode(request.getPath()));
170 } catch (FailedDataTreeModificationException e) {
171 return request.toRequestFailure(new RuntimeRequestException("Failed to access data",
172 ReadFailedException.MAPPER.apply(e)));
176 private boolean handleReadRequest(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
177 // Note we delay completion of read requests to limit the scope at which the client can run, as they have
178 // listeners, which we do not want to execute while we are reconnecting.
179 if (request instanceof ReadTransactionRequest) {
180 if (callback != null) {
181 final var response = handleReadRequest(readOnlyView(), (ReadTransactionRequest) request);
182 executeInActor(() -> callback.accept(response));
185 } else if (request instanceof ExistsTransactionRequest) {
186 if (callback != null) {
187 final var response = handleExistsRequest(readOnlyView(), (ExistsTransactionRequest) request);
188 executeInActor(() -> callback.accept(response));
197 final void forwardToRemote(final RemoteProxyTransaction successor, final TransactionRequest<?> request,
198 final Consumer<Response<?, ?>> callback) {
199 if (request instanceof final CommitLocalTransactionRequest req) {
200 final DataTreeModification mod = req.getModification();
202 LOG.debug("Applying modification {} to successor {}", mod, successor);
203 mod.applyToCursor(new AbstractDataTreeModificationCursor() {
205 public void write(final PathArgument child, final NormalizedNode data) {
206 successor.write(current().node(child), data);
210 public void merge(final PathArgument child, final NormalizedNode data) {
211 successor.merge(current().node(child), data);
215 public void delete(final PathArgument child) {
216 successor.delete(current().node(child));
220 successor.sealOnly();
221 final ModifyTransactionRequest successorReq = successor.commitRequest(req.isCoordinated());
222 successor.sendRequest(successorReq, callback);
223 } else if (request instanceof AbortLocalTransactionRequest) {
224 LOG.debug("Forwarding abort {} to successor {}", request, successor);
226 } else if (request instanceof TransactionPurgeRequest) {
227 LOG.debug("Forwarding purge {} to successor {}", request, successor);
228 successor.enqueuePurge(callback);
229 } else if (request instanceof ModifyTransactionRequest) {
230 successor.handleForwardedRequest(request, callback);
232 throw unhandledRequest(request);
237 void forwardToLocal(final LocalProxyTransaction successor, final TransactionRequest<?> request,
238 final Consumer<Response<?, ?>> callback) {
239 if (request instanceof AbortLocalTransactionRequest) {
240 successor.sendAbort(request, callback);
241 } else if (request instanceof TransactionPurgeRequest) {
242 successor.enqueuePurge(callback);
244 throw unhandledRequest(request);
247 LOG.debug("Forwarded request {} to successor {}", request, successor);
250 void sendAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback) {
251 sendRequest(request, callback);
254 void enqueueAbort(final TransactionRequest<?> request, final Consumer<Response<?, ?>> callback,
255 final long enqueuedTicks) {
256 enqueueRequest(request, callback, enqueuedTicks);