/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.cluster.datastore;
import akka.actor.ActorRef;
import akka.actor.PoisonPill;
import akka.actor.Props;
import akka.actor.ReceiveTimeout;
import akka.japi.Creator;
import com.google.common.base.Optional;
import com.google.common.base.Preconditions;
import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering;
import org.opendaylight.controller.cluster.datastore.TransactionProxy.TransactionType;
import org.opendaylight.controller.cluster.datastore.exceptions.UnknownMessageException;
import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
import org.opendaylight.controller.cluster.datastore.messages.CloseTransactionReply;
import org.opendaylight.controller.cluster.datastore.messages.DataExists;
import org.opendaylight.controller.cluster.datastore.messages.DataExistsReply;
import org.opendaylight.controller.cluster.datastore.messages.ReadData;
import org.opendaylight.controller.cluster.datastore.messages.ReadDataReply;
import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
/**
* The ShardTransaction Actor represents a remote transaction
*
* The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
*
*
* Handles Messages
* ----------------
*
{@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
* {@link org.opendaylight.controller.cluster.datastore.messages.WriteData}
* {@link org.opendaylight.controller.cluster.datastore.messages.MergeData}
* {@link org.opendaylight.controller.cluster.datastore.messages.DeleteData}
* {@link org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction}
* {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
*
*/
public abstract class ShardTransaction extends AbstractUntypedActorWithMetering {
protected static final boolean SERIALIZED_REPLY = true;
private final ActorRef shardActor;
private final ShardStats shardStats;
private final String transactionID;
private final short clientTxVersion;
protected ShardTransaction(ActorRef shardActor, ShardStats shardStats, String transactionID,
short clientTxVersion) {
super("shard-tx"); //actor name override used for metering. This does not change the "real" actor name
this.shardActor = shardActor;
this.shardStats = shardStats;
this.transactionID = transactionID;
this.clientTxVersion = clientTxVersion;
}
public static Props props(TransactionType type, AbstractShardDataTreeTransaction> transaction, ActorRef shardActor,
DatastoreContext datastoreContext, ShardStats shardStats, String transactionID, short txnClientVersion) {
return Props.create(new ShardTransactionCreator(type, transaction, shardActor,
datastoreContext, shardStats, transactionID, txnClientVersion));
}
protected abstract AbstractShardDataTreeTransaction> getDOMStoreTransaction();
protected ActorRef getShardActor() {
return shardActor;
}
protected String getTransactionID() {
return transactionID;
}
protected short getClientTxVersion() {
return clientTxVersion;
}
@Override
public void handleReceive(Object message) throws Exception {
if (message.getClass().equals(CloseTransaction.SERIALIZABLE_CLASS)) {
closeTransaction(true);
} else if (message instanceof ReceiveTimeout) {
if(LOG.isDebugEnabled()) {
LOG.debug("Got ReceiveTimeout for inactivity - closing Tx");
}
closeTransaction(false);
} else {
throw new UnknownMessageException(message);
}
}
protected boolean returnCloseTransactionReply() {
return true;
}
private void closeTransaction(boolean sendReply) {
getDOMStoreTransaction().abort();
if(sendReply && returnCloseTransactionReply()) {
getSender().tell(CloseTransactionReply.INSTANCE.toSerializable(), getSelf());
}
getSelf().tell(PoisonPill.getInstance(), getSelf());
}
private boolean checkClosed(AbstractShardDataTreeTransaction> transaction) {
final boolean ret = transaction.isClosed();
if (ret) {
shardStats.incrementFailedReadTransactionsCount();
getSender().tell(new akka.actor.Status.Failure(new ReadFailedException("Transaction is closed")), getSelf());
}
return ret;
}
protected void readData(AbstractShardDataTreeTransaction> transaction, ReadData message,
final boolean returnSerialized) {
if (checkClosed(transaction)) {
return;
}
final YangInstanceIdentifier path = message.getPath();
Optional> optional = transaction.getSnapshot().readNode(path);
ReadDataReply readDataReply = new ReadDataReply(optional.orNull(), clientTxVersion);
sender().tell((returnSerialized ? readDataReply.toSerializable(): readDataReply), self());
}
protected void dataExists(AbstractShardDataTreeTransaction> transaction, DataExists message,
final boolean returnSerialized) {
if (checkClosed(transaction)) {
return;
}
final YangInstanceIdentifier path = message.getPath();
boolean exists = transaction.getSnapshot().readNode(path).isPresent();
DataExistsReply dataExistsReply = DataExistsReply.create(exists);
getSender().tell(returnSerialized ? dataExistsReply.toSerializable() :
dataExistsReply, getSelf());
}
private static class ShardTransactionCreator implements Creator {
private static final long serialVersionUID = 1L;
final AbstractShardDataTreeTransaction> transaction;
final ActorRef shardActor;
final DatastoreContext datastoreContext;
final ShardStats shardStats;
final String transactionID;
final short txnClientVersion;
final TransactionType type;
ShardTransactionCreator(TransactionType type, AbstractShardDataTreeTransaction> transaction, ActorRef shardActor,
DatastoreContext datastoreContext, ShardStats shardStats, String transactionID, short txnClientVersion) {
this.transaction = Preconditions.checkNotNull(transaction);
this.shardActor = shardActor;
this.shardStats = shardStats;
this.datastoreContext = datastoreContext;
this.transactionID = transactionID;
this.txnClientVersion = txnClientVersion;
this.type = type;
}
@Override
public ShardTransaction create() throws Exception {
final ShardTransaction tx;
switch (type) {
case READ_ONLY:
tx = new ShardReadTransaction(transaction, shardActor,
shardStats, transactionID, txnClientVersion);
break;
case READ_WRITE:
tx = new ShardReadWriteTransaction((ReadWriteShardDataTreeTransaction)transaction,
shardActor, shardStats, transactionID, txnClientVersion);
break;
case WRITE_ONLY:
tx = new ShardWriteTransaction((ReadWriteShardDataTreeTransaction)transaction,
shardActor, shardStats, transactionID, txnClientVersion);
break;
default:
throw new IllegalArgumentException("Unhandled transaction type " + type);
}
tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());
return tx;
}
}
}