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.ActorRef;
12 import akka.actor.PoisonPill;
13 import akka.actor.Props;
14 import akka.actor.ReceiveTimeout;
15 import akka.japi.Creator;
17 import com.google.common.base.Optional;
18 import com.google.common.util.concurrent.CheckedFuture;
19 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActor;
22 import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException;
23 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
24 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
25 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply;
26 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
27 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
28 import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
29 import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
30 import org.opendaylight.controller.cluster.datastore.messages.MergeData;
31 import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
32 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
33 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
34 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
35 import org.opendaylight.controller.cluster.datastore.messages.ReadyTransactionReply;
36 import org.opendaylight.controller.cluster.datastore.messages.WriteData;
37 import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
38 import org.opendaylight.controller.cluster.datastore.modification.CompositeModification;
39 import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
40 import org.opendaylight.controller.cluster.datastore.modification.ImmutableCompositeModification;
41 import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
42 import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
43 import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
44 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
45 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadTransaction;
46 import org.opendaylight.controller.sal.core.spi.data.DOMStoreReadWriteTransaction;
47 import org.opendaylight.controller.sal.core.spi.data.DOMStoreThreePhaseCommitCohort;
48 import org.opendaylight.controller.sal.core.spi.data.DOMStoreTransaction;
49 import org.opendaylight.controller.sal.core.spi.data.DOMStoreWriteTransaction;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
52 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
55 * The ShardTransaction Actor represents a remote transaction
57 * The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
60 * Even though the DOMStore and the DOMStoreTransactionChain implement multiple types of transactions
61 * the ShardTransaction Actor only works with read-write transactions. This is just to keep the logic simple. At this
62 * time there are no known advantages for creating a read-only or write-only transaction which may change over time
63 * at which point we can optimize things in the distributed store as well.
66 * Handles Messages <br/>
67 * ---------------- <br/>
68 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
69 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.WriteData}
70 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.MergeData}
71 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData}
72 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction}
73 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
76 public abstract class ShardTransaction extends AbstractUntypedActor {
78 private final ActorRef shardActor;
79 protected final SchemaContext schemaContext;
80 private final ShardStats shardStats;
82 private final MutableCompositeModification modification = new MutableCompositeModification();
84 protected ShardTransaction(ActorRef shardActor, SchemaContext schemaContext,
85 ShardStats shardStats) {
86 this.shardActor = shardActor;
87 this.schemaContext = schemaContext;
88 this.shardStats = shardStats;
91 public static Props props(DOMStoreTransaction transaction, ActorRef shardActor,
92 SchemaContext schemaContext,DatastoreContext datastoreContext, ShardStats shardStats) {
93 return Props.create(new ShardTransactionCreator(transaction, shardActor, schemaContext,
94 datastoreContext, shardStats));
97 protected abstract DOMStoreTransaction getDOMStoreTransaction();
100 public void handleReceive(Object message) throws Exception {
101 if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) {
102 closeTransaction(true);
103 } else if (message instanceof GetCompositedModification) {
104 // This is here for testing only
105 getSender().tell(new GetCompositeModificationReply(
106 new ImmutableCompositeModification(modification)), getSelf());
107 } else if (message instanceof ReceiveTimeout) {
108 if(LOG.isDebugEnabled()) {
109 LOG.debug("Got ReceiveTimeout for inactivity - closing Tx");
111 closeTransaction(false);
113 throw new UnknownMessageException(message);
117 private void closeTransaction(boolean sendReply) {
118 getDOMStoreTransaction().close();
121 getSender().tell(new CloseTransactionReply().toSerializable(), getSelf());
124 getSelf().tell(PoisonPill.getInstance(), getSelf());
127 protected void readData(DOMStoreReadTransaction transaction,ReadData message) {
128 final ActorRef sender = getSender();
129 final ActorRef self = getSelf();
130 final YangInstanceIdentifier path = message.getPath();
131 final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> future =
132 transaction.read(path);
134 future.addListener(new Runnable() {
138 Optional<NormalizedNode<?, ?>> optional = future.checkedGet();
139 if (optional.isPresent()) {
140 sender.tell(new ReadDataReply(schemaContext,optional.get()).toSerializable(), self);
142 sender.tell(new ReadDataReply(schemaContext,null).toSerializable(), self);
144 } catch (Exception e) {
145 shardStats.incrementFailedReadTransactionsCount();
146 sender.tell(new akka.actor.Status.Failure(e), self);
150 }, getContext().dispatcher());
153 protected void dataExists(DOMStoreReadTransaction transaction, DataExists message) {
154 final YangInstanceIdentifier path = message.getPath();
157 Boolean exists = transaction.exists(path).checkedGet();
158 getSender().tell(new DataExistsReply(exists).toSerializable(), getSelf());
159 } catch (ReadFailedException e) {
160 getSender().tell(new akka.actor.Status.Failure(e),getSelf());
165 protected void writeData(DOMStoreWriteTransaction transaction, WriteData message) {
166 modification.addModification(
167 new WriteModification(message.getPath(), message.getData(),schemaContext));
168 if(LOG.isDebugEnabled()) {
169 LOG.debug("writeData at path : " + message.getPath().toString());
172 transaction.write(message.getPath(), message.getData());
173 getSender().tell(new WriteDataReply().toSerializable(), getSelf());
175 getSender().tell(new akka.actor.Status.Failure(e), getSelf());
179 protected void mergeData(DOMStoreWriteTransaction transaction, MergeData message) {
180 modification.addModification(
181 new MergeModification(message.getPath(), message.getData(), schemaContext));
182 if(LOG.isDebugEnabled()) {
183 LOG.debug("mergeData at path : " + message.getPath().toString());
186 transaction.merge(message.getPath(), message.getData());
187 getSender().tell(new MergeDataReply().toSerializable(), getSelf());
189 getSender().tell(new akka.actor.Status.Failure(e), getSelf());
193 protected void deleteData(DOMStoreWriteTransaction transaction, DeleteData message) {
194 if(LOG.isDebugEnabled()) {
195 LOG.debug("deleteData at path : " + message.getPath().toString());
197 modification.addModification(new DeleteModification(message.getPath()));
199 transaction.delete(message.getPath());
200 getSender().tell(new DeleteDataReply().toSerializable(), getSelf());
202 getSender().tell(new akka.actor.Status.Failure(e), getSelf());
206 protected void readyTransaction(DOMStoreWriteTransaction transaction, ReadyTransaction message) {
207 DOMStoreThreePhaseCommitCohort cohort = transaction.ready();
208 ActorRef cohortActor = getContext().actorOf(
209 ThreePhaseCommitCohort.props(cohort, shardActor, modification, shardStats), "cohort");
211 .tell(new ReadyTransactionReply(cohortActor.path()).toSerializable(), getSelf());
215 private static class ShardTransactionCreator implements Creator<ShardTransaction> {
217 private static final long serialVersionUID = 1L;
219 final DOMStoreTransaction transaction;
220 final ActorRef shardActor;
221 final SchemaContext schemaContext;
222 final DatastoreContext datastoreContext;
223 final ShardStats shardStats;
225 ShardTransactionCreator(DOMStoreTransaction transaction, ActorRef shardActor,
226 SchemaContext schemaContext, DatastoreContext datastoreContext,
227 ShardStats shardStats) {
228 this.transaction = transaction;
229 this.shardActor = shardActor;
230 this.shardStats = shardStats;
231 this.schemaContext = schemaContext;
232 this.datastoreContext = datastoreContext;
236 public ShardTransaction create() throws Exception {
238 if(transaction instanceof DOMStoreReadWriteTransaction) {
239 tx = new ShardReadWriteTransaction((DOMStoreReadWriteTransaction)transaction,
240 shardActor, schemaContext, shardStats);
241 } else if(transaction instanceof DOMStoreReadTransaction) {
242 tx = new ShardReadTransaction((DOMStoreReadTransaction)transaction, shardActor,
243 schemaContext, shardStats);
245 tx = new ShardWriteTransaction((DOMStoreWriteTransaction)transaction,
246 shardActor, schemaContext, shardStats);
249 tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());
254 // These classes are in here for test purposes only
256 static class GetCompositedModification {
260 static class GetCompositeModificationReply {
261 private final CompositeModification modification;
264 GetCompositeModificationReply(CompositeModification modification) {
265 this.modification = modification;
269 public CompositeModification getModification() {