2 * Copyright (c) 2014 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
9 package org.opendaylight.controller.cluster.datastore;
11 import akka.actor.ActorPath;
12 import akka.actor.ActorSelection;
13 import akka.dispatch.Futures;
14 import akka.dispatch.OnComplete;
16 import com.google.common.annotations.VisibleForTesting;
17 import com.google.common.collect.Lists;
18 import com.google.common.util.concurrent.ListenableFuture;
19 import com.google.common.util.concurrent.SettableFuture;
21 import org.opendaylight.controller.cluster.datastore.messages.AbortTransaction;
22 import org.opendaylight.controller.cluster.datastore.messages.AbortTransactionReply;
23 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransaction;
24 import org.opendaylight.controller.cluster.datastore.messages.CanCommitTransactionReply;
25 import org.opendaylight.controller.cluster.datastore.messages.CommitTransaction;
26 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
27 import org.opendaylight.controller.cluster.datastore.messages.PreCommitTransaction;
28 import org.opendaylight.controller.cluster.datastore.messages.PreCommitTransactionReply;
29 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
30 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
34 import scala.concurrent.Future;
35 import scala.runtime.AbstractFunction1;
37 import java.util.Collections;
38 import java.util.List;
41 * ThreePhaseCommitCohortProxy represents a set of remote cohort proxies
43 public class ThreePhaseCommitCohortProxy implements DOMStoreThreePhaseCommitCohort{
45 private static final Logger LOG = LoggerFactory.getLogger(ThreePhaseCommitCohortProxy.class);
47 private final ActorContext actorContext;
48 private final List<Future<ActorPath>> cohortPathFutures;
49 private volatile List<ActorPath> cohortPaths;
50 private final String transactionId;
52 public ThreePhaseCommitCohortProxy(ActorContext actorContext,
53 List<Future<ActorPath>> cohortPathFutures, String transactionId) {
54 this.actorContext = actorContext;
55 this.cohortPathFutures = cohortPathFutures;
56 this.transactionId = transactionId;
59 private Future<Void> buildCohortPathsList() {
61 Future<Iterable<ActorPath>> combinedFutures = Futures.sequence(cohortPathFutures,
62 actorContext.getActorSystem().dispatcher());
64 return combinedFutures.transform(new AbstractFunction1<Iterable<ActorPath>, Void>() {
66 public Void apply(Iterable<ActorPath> paths) {
67 cohortPaths = Lists.newArrayList(paths);
69 LOG.debug("Tx {} successfully built cohort path list: {}",
70 transactionId, cohortPaths);
73 }, TransactionProxy.SAME_FAILURE_TRANSFORMER, actorContext.getActorSystem().dispatcher());
77 public ListenableFuture<Boolean> canCommit() {
78 LOG.debug("Tx {} canCommit", transactionId);
80 final SettableFuture<Boolean> returnFuture = SettableFuture.create();
82 // The first phase of canCommit is to gather the list of cohort actor paths that will
83 // participate in the commit. buildCohortPathsList combines the cohort path Futures into
84 // one Future which we wait on asynchronously here. The cohort actor paths are
85 // extracted from ReadyTransactionReply messages by the Futures that were obtained earlier
86 // and passed to us from upstream processing. If any one fails then we'll fail canCommit.
88 buildCohortPathsList().onComplete(new OnComplete<Void>() {
90 public void onComplete(Throwable failure, Void notUsed) throws Throwable {
92 LOG.debug("Tx {}: a cohort path Future failed: {}", transactionId, failure);
93 returnFuture.setException(failure);
95 finishCanCommit(returnFuture);
98 }, actorContext.getActorSystem().dispatcher());
103 private void finishCanCommit(final SettableFuture<Boolean> returnFuture) {
105 LOG.debug("Tx {} finishCanCommit", transactionId);
107 // The last phase of canCommit is to invoke all the cohort actors asynchronously to perform
108 // their canCommit processing. If any one fails then we'll fail canCommit.
110 Future<Iterable<Object>> combinedFuture =
111 invokeCohorts(new CanCommitTransaction().toSerializable());
113 combinedFuture.onComplete(new OnComplete<Iterable<Object>>() {
115 public void onComplete(Throwable failure, Iterable<Object> responses) throws Throwable {
116 if(failure != null) {
117 LOG.debug("Tx {}: a canCommit cohort Future failed: {}", transactionId, failure);
118 returnFuture.setException(failure);
122 boolean result = true;
123 for(Object response: responses) {
124 if (response.getClass().equals(CanCommitTransactionReply.SERIALIZABLE_CLASS)) {
125 CanCommitTransactionReply reply =
126 CanCommitTransactionReply.fromSerializable(response);
127 if (!reply.getCanCommit()) {
132 LOG.error("Unexpected response type {}", response.getClass());
133 returnFuture.setException(new IllegalArgumentException(
134 String.format("Unexpected response type {}", response.getClass())));
139 LOG.debug("Tx {}: canCommit returning result: {}", transactionId, result);
141 returnFuture.set(Boolean.valueOf(result));
143 }, actorContext.getActorSystem().dispatcher());
146 private Future<Iterable<Object>> invokeCohorts(Object message) {
147 List<Future<Object>> futureList = Lists.newArrayListWithCapacity(cohortPaths.size());
148 for(ActorPath actorPath : cohortPaths) {
150 LOG.debug("Tx {}: Sending {} to cohort {}", transactionId, message, actorPath);
152 ActorSelection cohort = actorContext.actorSelection(actorPath);
154 futureList.add(actorContext.executeRemoteOperationAsync(cohort, message,
155 ActorContext.ASK_DURATION));
158 return Futures.sequence(futureList, actorContext.getActorSystem().dispatcher());
162 public ListenableFuture<Void> preCommit() {
163 return voidOperation("preCommit", new PreCommitTransaction().toSerializable(),
164 PreCommitTransactionReply.SERIALIZABLE_CLASS, true);
168 public ListenableFuture<Void> abort() {
169 // Note - we pass false for propagateException. In the front-end data broker, this method
170 // is called when one of the 3 phases fails with an exception. We'd rather have that
171 // original exception propagated to the client. If our abort fails and we propagate the
172 // exception then that exception will supersede and suppress the original exception. But
173 // it's the original exception that is the root cause and of more interest to the client.
175 return voidOperation("abort", new AbortTransaction().toSerializable(),
176 AbortTransactionReply.SERIALIZABLE_CLASS, false);
180 public ListenableFuture<Void> commit() {
181 return voidOperation("commit", new CommitTransaction().toSerializable(),
182 CommitTransactionReply.SERIALIZABLE_CLASS, true);
185 private ListenableFuture<Void> voidOperation(final String operationName, final Object message,
186 final Class<?> expectedResponseClass, final boolean propagateException) {
188 LOG.debug("Tx {} {}", transactionId, operationName);
190 final SettableFuture<Void> returnFuture = SettableFuture.create();
192 // The cohort actor list should already be built at this point by the canCommit phase but,
193 // if not for some reason, we'll try to build it here.
195 if(cohortPaths != null) {
196 finishVoidOperation(operationName, message, expectedResponseClass, propagateException,
199 buildCohortPathsList().onComplete(new OnComplete<Void>() {
201 public void onComplete(Throwable failure, Void notUsed) throws Throwable {
202 if(failure != null) {
203 LOG.debug("Tx {}: a {} cohort path Future failed: {}", transactionId,
204 operationName, failure);
206 if(propagateException) {
207 returnFuture.setException(failure);
209 returnFuture.set(null);
212 finishVoidOperation(operationName, message, expectedResponseClass,
213 propagateException, returnFuture);
216 }, actorContext.getActorSystem().dispatcher());
222 private void finishVoidOperation(final String operationName, final Object message,
223 final Class<?> expectedResponseClass, final boolean propagateException,
224 final SettableFuture<Void> returnFuture) {
226 LOG.debug("Tx {} finish {}", transactionId, operationName);
228 Future<Iterable<Object>> combinedFuture = invokeCohorts(message);
230 combinedFuture.onComplete(new OnComplete<Iterable<Object>>() {
232 public void onComplete(Throwable failure, Iterable<Object> responses) throws Throwable {
234 Throwable exceptionToPropagate = failure;
235 if(exceptionToPropagate == null) {
236 for(Object response: responses) {
237 if(!response.getClass().equals(expectedResponseClass)) {
238 exceptionToPropagate = new IllegalArgumentException(
239 String.format("Unexpected response type {}",
240 response.getClass()));
246 if(exceptionToPropagate != null) {
247 LOG.debug("Tx {}: a {} cohort Future failed: {}", transactionId,
248 operationName, exceptionToPropagate);
250 if(propagateException) {
251 // We don't log the exception here to avoid redundant logging since we're
252 // propagating to the caller in MD-SAL core who will log it.
253 returnFuture.setException(exceptionToPropagate);
255 // Since the caller doesn't want us to propagate the exception we'll also
256 // not log it normally. But it's usually not good to totally silence
257 // exceptions so we'll log it to debug level.
258 LOG.debug(String.format("%s failed", message.getClass().getSimpleName()),
259 exceptionToPropagate);
260 returnFuture.set(null);
263 LOG.debug("Tx {}: {} succeeded", transactionId, operationName);
264 returnFuture.set(null);
267 }, actorContext.getActorSystem().dispatcher());
271 List<Future<ActorPath>> getCohortPathFutures() {
272 return Collections.unmodifiableList(cohortPathFutures);