Usage of Collections.unmodifiableCollection is unsafe

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / main / java / org / opendaylight / controller / cluster / datastore / ShardTransaction.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java
index ee38d1918e13442dc6983a40cabc6ac64e77b65e..e3fbb82ee805b610d0d02c782ff47f5b55da5c3f 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/ShardTransaction.java
@@ -15,6 +15,8 @@ import akka.actor.ReceiveTimeout;
 import akka.japi.Creator;
 import com.google.common.base.Optional;
 import com.google.common.base.Preconditions;
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
 import org.opendaylight.controller.cluster.common.actor.AbstractUntypedActorWithMetering;
 import org.opendaylight.controller.cluster.datastore.jmx.mbeans.shard.ShardStats;
 import org.opendaylight.controller.cluster.datastore.messages.CloseTransaction;
@@ -28,31 +30,22 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 
 /**
- * The ShardTransaction Actor represents a remote transaction
- * <p>
- * The ShardTransaction Actor delegates all actions to DOMDataReadWriteTransaction
- * </p>
- * <p>
- * Handles Messages <br/>
- * ---------------- <br/>
- * <li> {@link org.opendaylight.controller.cluster.datastore.messages.ReadData}
- * <li> {@link org.opendaylight.controller.cluster.datastore.messages.CloseTransaction}
- * </p>
+ * The ShardTransaction Actor represents a remote transaction that delegates all actions to DOMDataReadWriteTransaction.
  */
 public abstract class ShardTransaction extends AbstractUntypedActorWithMetering {
     private final ActorRef shardActor;
     private final ShardStats shardStats;
-    private final String transactionID;
+    private final TransactionIdentifier transactionId;
 
-    protected ShardTransaction(ActorRef shardActor, ShardStats shardStats, String transactionID) {
+    protected ShardTransaction(ActorRef shardActor, ShardStats shardStats, TransactionIdentifier transactionId) {
         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 = Preconditions.checkNotNull(transactionID);
+        this.transactionId = Preconditions.checkNotNull(transactionId);
     }
 
-    public static Props props(TransactionType type, AbstractShardDataTreeTransaction<?> transaction, ActorRef shardActor,
-            DatastoreContext datastoreContext, ShardStats shardStats) {
+    public static Props props(TransactionType type, AbstractShardDataTreeTransaction<?> transaction,
+            ActorRef shardActor, DatastoreContext datastoreContext, ShardStats shardStats) {
         return Props.create(new ShardTransactionCreator(type, transaction, shardActor, datastoreContext, shardStats));
     }
 
@@ -62,8 +55,8 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         return shardActor;
     }
 
-    protected String getTransactionID() {
-        return transactionID;
+    protected final TransactionIdentifier getTransactionId() {
+        return transactionId;
     }
 
     @Override
@@ -71,7 +64,7 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         if (CloseTransaction.isSerializedType(message)) {
             closeTransaction(true);
         } else if (message instanceof ReceiveTimeout) {
-            LOG.debug("Got ReceiveTimeout for inactivity - closing transaction {}", transactionID);
+            LOG.debug("Got ReceiveTimeout for inactivity - closing transaction {}", transactionId);
             closeTransaction(false);
         } else {
             unknownMessage(message);
@@ -85,7 +78,7 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
     private void closeTransaction(boolean sendReply) {
         getDOMStoreTransaction().abort();
 
-        if(sendReply && returnCloseTransactionReply()) {
+        if (sendReply && returnCloseTransactionReply()) {
             getSender().tell(new CloseTransactionReply(), getSelf());
         }
 
@@ -96,7 +89,8 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         final boolean ret = transaction.isClosed();
         if (ret) {
             shardStats.incrementFailedReadTransactionsCount();
-            getSender().tell(new akka.actor.Status.Failure(new ReadFailedException("Transaction is closed")), getSelf());
+            getSender().tell(new akka.actor.Status.Failure(new ReadFailedException("Transaction is closed")),
+                    getSelf());
         }
         return ret;
     }
@@ -122,6 +116,8 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         getSender().tell(new DataExistsReply(exists, message.getVersion()).toSerializable(), getSelf());
     }
 
+    @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "Some fields are not Serializable but we don't "
+            + "create remote instances of this actor and thus don't need it to be Serializable.")
     private static class ShardTransactionCreator implements Creator<ShardTransaction> {
 
         private static final long serialVersionUID = 1L;
@@ -132,8 +128,8 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         final ShardStats shardStats;
         final TransactionType type;
 
-        ShardTransactionCreator(TransactionType type, AbstractShardDataTreeTransaction<?> transaction, ActorRef shardActor,
-                DatastoreContext datastoreContext, ShardStats shardStats) {
+        ShardTransactionCreator(TransactionType type, AbstractShardDataTreeTransaction<?> transaction,
+                ActorRef shardActor, DatastoreContext datastoreContext, ShardStats shardStats) {
             this.transaction = Preconditions.checkNotNull(transaction);
             this.shardActor = shardActor;
             this.shardStats = shardStats;
@@ -145,17 +141,19 @@ public abstract class ShardTransaction extends AbstractUntypedActorWithMetering
         public ShardTransaction create() throws Exception {
             final ShardTransaction tx;
             switch (type) {
-            case READ_ONLY:
-                tx = new ShardReadTransaction(transaction, shardActor, shardStats);
-                break;
-            case READ_WRITE:
-                tx = new ShardReadWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor, shardStats);
-                break;
-            case WRITE_ONLY:
-                tx = new ShardWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor, shardStats);
-                break;
-            default:
-                throw new IllegalArgumentException("Unhandled transaction type " + type);
+                case READ_ONLY:
+                    tx = new ShardReadTransaction(transaction, shardActor, shardStats);
+                    break;
+                case READ_WRITE:
+                    tx = new ShardReadWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor,
+                            shardStats);
+                    break;
+                case WRITE_ONLY:
+                    tx = new ShardWriteTransaction((ReadWriteShardDataTreeTransaction)transaction, shardActor,
+                            shardStats);
+                    break;
+                default:
+                    throw new IllegalArgumentException("Unhandled transaction type " + type);
             }
 
             tx.getContext().setReceiveTimeout(datastoreContext.getShardTransactionIdleTimeout());