1419a520355aedf1002a4dba613e1f3707d1acd6
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / LocalThreePhaseCommitCohort.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
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
7  */
8 package org.opendaylight.controller.cluster.datastore;
9
10 import akka.actor.ActorSelection;
11 import akka.dispatch.Futures;
12 import akka.dispatch.OnComplete;
13 import com.google.common.base.Preconditions;
14 import com.google.common.util.concurrent.ListenableFuture;
15 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
16 import org.opendaylight.controller.cluster.datastore.messages.CommitTransactionReply;
17 import org.opendaylight.controller.cluster.datastore.messages.ReadyLocalTransaction;
18 import org.opendaylight.controller.cluster.datastore.utils.ActorContext;
19 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
20 import org.opendaylight.controller.sal.core.spi.data.SnapshotBackedWriteTransaction;
21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
22 import org.slf4j.Logger;
23 import org.slf4j.LoggerFactory;
24 import scala.concurrent.Future;
25
26 /**
27  * Fake {@link DOMStoreThreePhaseCommitCohort} instantiated for local transactions to conform with the DOM
28  * transaction APIs. It is only used to hold the data from a local DOM transaction ready operation and to
29  * initiate direct or coordinated commits from the front-end by sending the ReadyLocalTransaction message.
30  * It is not actually called by the front-end to perform 3PC thus the canCommit/preCommit/commit methods
31  * are no-ops.
32  */
33 class LocalThreePhaseCommitCohort implements DOMStoreThreePhaseCommitCohort {
34     private static final Logger LOG = LoggerFactory.getLogger(LocalThreePhaseCommitCohort.class);
35
36     private final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction;
37     private final DataTreeModification modification;
38     private final ActorContext actorContext;
39     private final ActorSelection leader;
40     private final Exception operationError;
41
42     protected LocalThreePhaseCommitCohort(final ActorContext actorContext, final ActorSelection leader,
43             final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction, final DataTreeModification modification) {
44         this.actorContext = Preconditions.checkNotNull(actorContext);
45         this.leader = Preconditions.checkNotNull(leader);
46         this.transaction = Preconditions.checkNotNull(transaction);
47         this.modification = Preconditions.checkNotNull(modification);
48         this.operationError = null;
49     }
50
51     protected LocalThreePhaseCommitCohort(final ActorContext actorContext, final ActorSelection leader,
52             final SnapshotBackedWriteTransaction<TransactionIdentifier> transaction, final Exception operationError) {
53         this.actorContext = Preconditions.checkNotNull(actorContext);
54         this.leader = Preconditions.checkNotNull(leader);
55         this.transaction = Preconditions.checkNotNull(transaction);
56         this.operationError = Preconditions.checkNotNull(operationError);
57         this.modification = null;
58     }
59
60     private Future<Object> initiateCommit(final boolean immediate) {
61         if(operationError != null) {
62             return Futures.failed(operationError);
63         }
64
65         final ReadyLocalTransaction message = new ReadyLocalTransaction(transaction.getIdentifier(),
66                 modification, immediate);
67         return actorContext.executeOperationAsync(leader, message, actorContext.getTransactionCommitOperationTimeout());
68     }
69
70     Future<ActorSelection> initiateCoordinatedCommit() {
71         final Future<Object> messageFuture = initiateCommit(false);
72         final Future<ActorSelection> ret = TransactionReadyReplyMapper.transform(messageFuture, actorContext,
73                 transaction.getIdentifier());
74         ret.onComplete(new OnComplete<ActorSelection>() {
75             @Override
76             public void onComplete(final Throwable failure, final ActorSelection success) throws Throwable {
77                 if (failure != null) {
78                     LOG.info("Failed to prepare transaction {} on backend", transaction.getIdentifier(), failure);
79                     transactionAborted(transaction);
80                     return;
81                 }
82
83                 LOG.debug("Transaction {} resolved to actor {}", transaction.getIdentifier(), success);
84             }
85         }, actorContext.getClientDispatcher());
86
87         return ret;
88     }
89
90     Future<Object> initiateDirectCommit() {
91         final Future<Object> messageFuture = initiateCommit(true);
92         messageFuture.onComplete(new OnComplete<Object>() {
93             @Override
94             public void onComplete(final Throwable failure, final Object message) throws Throwable {
95                 if (failure != null) {
96                     LOG.error("Failed to prepare transaction {} on backend", transaction.getIdentifier(), failure);
97                     transactionAborted(transaction);
98                 } else if (CommitTransactionReply.isSerializedType(message)) {
99                     LOG.debug("Transaction {} committed successfully", transaction.getIdentifier());
100                     transactionCommitted(transaction);
101                 } else {
102                     LOG.error("Transaction {} resulted in unhandled message type {}, aborting", message.getClass());
103                     transactionAborted(transaction);
104                 }
105             }
106         }, actorContext.getClientDispatcher());
107
108         return messageFuture;
109     }
110
111     @Override
112     public final ListenableFuture<Boolean> canCommit() {
113         // Intended no-op
114         throw new UnsupportedOperationException();
115     }
116
117     @Override
118     public final ListenableFuture<Void> preCommit() {
119         // Intended no-op
120         throw new UnsupportedOperationException();
121     }
122
123     @Override
124     public final ListenableFuture<Void> abort() {
125         // Intended no-op
126         throw new UnsupportedOperationException();
127     }
128
129     @Override
130     public final ListenableFuture<Void> commit() {
131         // Intended no-op
132         throw new UnsupportedOperationException();
133     }
134
135     protected void transactionAborted(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
136     }
137
138     protected void transactionCommitted(SnapshotBackedWriteTransaction<TransactionIdentifier> transaction) {
139     }
140 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.