Cleanup ShardWriteTransaction
[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / ShardWriteTransaction.java
index 365f97dd3f8f7797ceb953f2b9b71606b4ba099b..67f2c684a15743e86c0855010bd72c492baf7fd3 100644 (file)
@@ -1,51 +1,38 @@
 /*
- *  Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
- *  Copyright (c) 2015 Brocade Communications 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
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ * Copyright (c) 2015 Brocade Communications 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 org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
 import org.opendaylight.controller.cluster.datastore.messages.BatchedModifications;
 import org.opendaylight.controller.cluster.datastore.messages.BatchedModificationsReply;
 import org.opendaylight.controller.cluster.datastore.messages.DataExists;
-import org.opendaylight.controller.cluster.datastore.messages.DeleteData;
-import org.opendaylight.controller.cluster.datastore.messages.DeleteDataReply;
 import org.opendaylight.controller.cluster.datastore.messages.ForwardedReadyTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.MergeData;
-import org.opendaylight.controller.cluster.datastore.messages.MergeDataReply;
 import org.opendaylight.controller.cluster.datastore.messages.ReadData;
-import org.opendaylight.controller.cluster.datastore.messages.ReadyTransaction;
-import org.opendaylight.controller.cluster.datastore.messages.WriteData;
-import org.opendaylight.controller.cluster.datastore.messages.WriteDataReply;
-import org.opendaylight.controller.cluster.datastore.modification.CompositeModification;
-import org.opendaylight.controller.cluster.datastore.modification.DeleteModification;
-import org.opendaylight.controller.cluster.datastore.modification.MergeModification;
 import org.opendaylight.controller.cluster.datastore.modification.Modification;
-import org.opendaylight.controller.cluster.datastore.modification.MutableCompositeModification;
-import org.opendaylight.controller.cluster.datastore.modification.WriteModification;
 
 /**
- * @author: syedbahm
- * Date: 8/6/14
+ * Actor for a shard write-only transaction.
+ *
+ * @author syedbahm
  */
 public class ShardWriteTransaction extends ShardTransaction {
 
-    private final MutableCompositeModification compositeModification = new MutableCompositeModification();
     private int totalBatchedModificationsReceived;
     private Exception lastBatchedModificationsException;
     private final ReadWriteShardDataTreeTransaction transaction;
 
-    public ShardWriteTransaction(ReadWriteShardDataTreeTransaction transaction, ActorRef shardActor,
-            ShardStats shardStats, String transactionID, short clientTxVersion) {
-        super(shardActor, shardStats, transactionID, clientTxVersion);
+    public ShardWriteTransaction(final ReadWriteShardDataTreeTransaction transaction, final ActorRef shardActor,
+            final ShardStats shardStats) {
+        super(shardActor, shardStats, transaction.getIdentifier());
         this.transaction = transaction;
     }
 
@@ -55,32 +42,16 @@ public class ShardWriteTransaction extends ShardTransaction {
     }
 
     @Override
-    public void handleReceive(Object message) throws Exception {
-
+    public void handleReceive(final Object message) {
         if (message instanceof BatchedModifications) {
             batchedModifications((BatchedModifications)message);
-        } else if (message instanceof ReadyTransaction) {
-            readyTransaction(!SERIALIZED_REPLY, false);
-        } else if(ReadyTransaction.SERIALIZABLE_CLASS.equals(message.getClass())) {
-            readyTransaction(SERIALIZED_REPLY, false);
-        } else if(WriteData.isSerializedType(message)) {
-            writeData(WriteData.fromSerializable(message), SERIALIZED_REPLY);
-
-        } else if(MergeData.isSerializedType(message)) {
-            mergeData(MergeData.fromSerializable(message), SERIALIZED_REPLY);
-
-        } else if(DeleteData.isSerializedType(message)) {
-            deleteData(DeleteData.fromSerializable(message), SERIALIZED_REPLY);
-
-        } else if (message instanceof GetCompositedModification) {
-            // This is here for testing only
-            getSender().tell(new GetCompositeModificationReply(compositeModification), getSelf());
         } else {
             super.handleReceive(message);
         }
     }
 
-    private void batchedModifications(BatchedModifications batched) {
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    private void batchedModifications(final BatchedModifications batched) {
         if (checkClosed()) {
             if (batched.isReady()) {
                 getSelf().tell(PoisonPill.getInstance(), getSelf());
@@ -89,24 +60,23 @@ public class ShardWriteTransaction extends ShardTransaction {
         }
 
         try {
-            for(Modification modification: batched.getModifications()) {
-                compositeModification.addModification(modification);
+            for (Modification modification: batched.getModifications()) {
                 modification.apply(transaction.getSnapshot());
             }
 
             totalBatchedModificationsReceived++;
-            if(batched.isReady()) {
-                if(lastBatchedModificationsException != null) {
+            if (batched.isReady()) {
+                if (lastBatchedModificationsException != null) {
                     throw lastBatchedModificationsException;
                 }
 
-                if(totalBatchedModificationsReceived != batched.getTotalMessagesSent()) {
+                if (totalBatchedModificationsReceived != batched.getTotalMessagesSent()) {
                     throw new IllegalStateException(String.format(
                             "The total number of batched messages received %d does not match the number sent %d",
                             totalBatchedModificationsReceived, batched.getTotalMessagesSent()));
                 }
 
-                readyTransaction(false, batched.isDoCommitOnReady());
+                readyTransaction(batched);
             } else {
                 getSender().tell(new BatchedModificationsReply(batched.getModifications().size()), getSelf());
             }
@@ -114,112 +84,38 @@ public class ShardWriteTransaction extends ShardTransaction {
             lastBatchedModificationsException = e;
             getSender().tell(new akka.actor.Status.Failure(e), getSelf());
 
-            if(batched.isReady()) {
+            if (batched.isReady()) {
                 getSelf().tell(PoisonPill.getInstance(), getSelf());
             }
         }
     }
 
-    protected final void dataExists(DataExists message, final boolean returnSerialized) {
-        super.dataExists(transaction, message, returnSerialized);
+    protected final void dataExists(final DataExists message) {
+        super.dataExists(transaction, message);
     }
 
-    protected final void readData(ReadData message, final boolean returnSerialized) {
-        super.readData(transaction, message, returnSerialized);
+    protected final void readData(final ReadData message) {
+        super.readData(transaction, message);
     }
 
     private boolean checkClosed() {
-        if (transaction.isClosed()) {
-            getSender().tell(new akka.actor.Status.Failure(new IllegalStateException("Transaction is closed, no modifications allowed")), getSelf());
-            return true;
-        } else {
-            return false;
+        final boolean ret = transaction.isClosed();
+        if (ret) {
+            getSender().tell(new akka.actor.Status.Failure(new IllegalStateException(
+                    "Transaction is closed, no modifications allowed")), getSelf());
         }
+        return ret;
     }
 
-    private void writeData(WriteData message, boolean returnSerialized) {
-        LOG.debug("writeData at path : {}", message.getPath());
-        if (checkClosed()) {
-            return;
-        }
-
-        compositeModification.addModification(
-                new WriteModification(message.getPath(), message.getData()));
-        try {
-            transaction.getSnapshot().write(message.getPath(), message.getData());
-            WriteDataReply writeDataReply = WriteDataReply.INSTANCE;
-            getSender().tell(returnSerialized ? writeDataReply.toSerializable(message.getVersion()) :
-                writeDataReply, getSelf());
-        }catch(Exception e){
-            getSender().tell(new akka.actor.Status.Failure(e), getSelf());
-        }
-    }
-
-    private void mergeData(MergeData message, boolean returnSerialized) {
-        LOG.debug("mergeData at path : {}", message.getPath());
-        if (checkClosed()) {
-            return;
-        }
-
-        compositeModification.addModification(
-                new MergeModification(message.getPath(), message.getData()));
-
-        try {
-            transaction.getSnapshot().merge(message.getPath(), message.getData());
-            MergeDataReply mergeDataReply = MergeDataReply.INSTANCE;
-            getSender().tell(returnSerialized ? mergeDataReply.toSerializable(message.getVersion()) :
-                mergeDataReply, getSelf());
-        }catch(Exception e){
-            getSender().tell(new akka.actor.Status.Failure(e), getSelf());
-        }
-    }
-
-    private void deleteData(DeleteData message, boolean returnSerialized) {
-        LOG.debug("deleteData at path : {}", message.getPath());
-        if (checkClosed()) {
-            return;
-        }
-
-        compositeModification.addModification(new DeleteModification(message.getPath()));
-        try {
-            transaction.getSnapshot().delete(message.getPath());
-            DeleteDataReply deleteDataReply = DeleteDataReply.INSTANCE;
-            getSender().tell(returnSerialized ? deleteDataReply.toSerializable(message.getVersion()) :
-                deleteDataReply, getSelf());
-        } catch(Exception e) {
-            getSender().tell(new akka.actor.Status.Failure(e), getSelf());
-        }
-    }
-
-    private void readyTransaction(boolean returnSerialized, boolean doImmediateCommit) {
-        String transactionID = getTransactionID();
+    private void readyTransaction(final BatchedModifications batched) {
+        TransactionIdentifier transactionID = getTransactionId();
 
         LOG.debug("readyTransaction : {}", transactionID);
 
-        ShardDataTreeCohort cohort =  transaction.ready();
-
-        getShardActor().forward(new ForwardedReadyTransaction(transactionID, getClientTxVersion(),
-                cohort, compositeModification, returnSerialized, doImmediateCommit), getContext());
+        getShardActor().forward(new ForwardedReadyTransaction(transactionID, batched.getVersion(),
+                transaction, batched.isDoCommitOnReady(), batched.getParticipatingShardNames()), getContext());
 
         // The shard will handle the commit from here so we're no longer needed - self-destruct.
         getSelf().tell(PoisonPill.getInstance(), getSelf());
     }
-
-    // These classes are in here for test purposes only
-
-    static class GetCompositedModification {
-    }
-
-    static class GetCompositeModificationReply {
-        private final CompositeModification modification;
-
-
-        GetCompositeModificationReply(CompositeModification modification) {
-            this.modification = modification;
-        }
-
-        public CompositeModification getModification() {
-            return modification;
-        }
-    }
 }