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;
16 import com.google.common.base.Optional;
17 import com.google.common.base.Preconditions;
18 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering;
19 import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException;
20 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
21 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
22 import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply;
23 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
24 import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
25 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
26 import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
27 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
29 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
32 * The ShardTransaction Actor represents a remote transaction
34 * The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
37 * Handles Messages <br/>
38 * ---------------- <br/>
39 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
40 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.WriteData}
41 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.MergeData}
42 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData}
43 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction}
44 * <li> {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
47 public abstract class ShardTransaction extends AbstractUntypedActorWithMetering {
49 protected static final boolean SERIALIZED_REPLY = true;
51 private final ActorRef shardActor;
52 private final ShardStats shardStats;
53 private final String transactionID;
54 private final short clientTxVersion;
56 protected ShardTransaction(ActorRef shardActor, ShardStats shardStats, String transactionID,
57 short clientTxVersion) {
58 super("shard-tx"); //actor name override used for metering. This does not change the "real" actor name
59 this.shardActor = shardActor;
60 this.shardStats = shardStats;
61 this.transactionID = Preconditions.checkNotNull(transactionID);
62 this.clientTxVersion = clientTxVersion;
65 public static Props props(TransactionType type, AbstractShardDataTreeTransaction<?> transaction, ActorRef shardActor,
66 DatastoreContext datastoreContext, ShardStats shardStats, String transactionID, short txnClientVersion) {
67 return Props.create(new ShardTransactionCreator(type, transaction, shardActor,
68 datastoreContext, shardStats, transactionID, txnClientVersion));
71 protected abstract AbstractShardDataTreeTransaction<?> getDOMStoreTransaction();
73 protected ActorRef getShardActor() {
77 protected String getTransactionID() {
81 protected short getClientTxVersion() {
82 return clientTxVersion;
86 public void handleReceive(Object message) throws Exception {
87 if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) {
88 closeTransaction(true);
89 } else if (message instanceof ReceiveTimeout) {
90 if(LOG.isDebugEnabled()) {
91 LOG.debug("Got ReceiveTimeout for inactivity - closing Tx");
93 closeTransaction(false);
95 throw new UnknownMessageException(message);
99 protected boolean returnCloseTransactionReply() {
103 private void closeTransaction(boolean sendReply) {
104 getDOMStoreTransaction().abort();
106 if(sendReply && returnCloseTransactionReply()) {
107 getSender().tell(CloseTransactionReply.INSTANCE.toSerializable(), getSelf());
110 getSelf().tell(PoisonPill.getInstance(), getSelf());
113 private boolean checkClosed(AbstractShardDataTreeTransaction<?> transaction) {
114 final boolean ret = transaction.isClosed();
116 shardStats.incrementFailedReadTransactionsCount();
117 getSender().tell(new akka.actor.Status.Failure(new ReadFailedException("Transaction is closed")), getSelf());
122 protected void readData(AbstractShardDataTreeTransaction<?> transaction, ReadData message,
123 final boolean returnSerialized) {
125 if (checkClosed(transaction)) {
129 final YangInstanceIdentifier path = message.getPath();
130 Optional<NormalizedNode<?, ?>> optional = transaction.getSnapshot().readNode(path);
131 ReadDataReply readDataReply = new ReadDataReply(optional.orNull(), clientTxVersion);
132 sender().tell((returnSerialized ? readDataReply.toSerializable(): readDataReply), self());
135 protected void dataExists(AbstractShardDataTreeTransaction<?> transaction, DataExists message,
136 final boolean returnSerialized) {
138 if (checkClosed(transaction)) {
142 final YangInstanceIdentifier path = message.getPath();
143 boolean exists = transaction.getSnapshot().readNode(path).isPresent();
144 DataExistsReply dataExistsReply = DataExistsReply.create(exists);
145 getSender().tell(returnSerialized ? dataExistsReply.toSerializable() :
146 dataExistsReply, getSelf());
149 private static class ShardTransactionCreator implements Creator<ShardTransaction> {
151 private static final long serialVersionUID = 1L;
153 final AbstractShardDataTreeTransaction<?> transaction;
154 final ActorRef shardActor;
155 final DatastoreContext datastoreContext;
156 final ShardStats shardStats;
157 final String transactionID;
158 final short txnClientVersion;
159 final TransactionType type;
161 ShardTransactionCreator(TransactionType type, AbstractShardDataTreeTransaction<?> transaction, ActorRef shardActor,
162 DatastoreContext datastoreContext, ShardStats shardStats, String transactionID, short txnClientVersion) {
163 this.transaction = Preconditions.checkNotNull(transaction);
164 this.shardActor = shardActor;
165 this.shardStats = shardStats;
166 this.datastoreContext = datastoreContext;
167 this.transactionID = Preconditions.checkNotNull(transactionID);
168 this.txnClientVersion = txnClientVersion;
173 public ShardTransaction create() throws Exception {
174 final ShardTransaction tx;
177 tx = new ShardReadTransaction(transaction, shardActor,
178 shardStats, transactionID, txnClientVersion);
181 tx = new ShardReadWriteTransaction((ReadWriteShardDataTreeTransaction)transaction,
182 shardActor, shardStats, transactionID, txnClientVersion);
185 tx = new ShardWriteTransaction((ReadWriteShardDataTreeTransaction)transaction,
186 shardActor, shardStats, transactionID, txnClientVersion);
189 throw new IllegalArgumentException("Unhandled transaction type " + type);
192 tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());