From a039b8a0d1592967542b199ed1634a04c40a99c5 Mon Sep 17 00:00:00 2001 From: Robert Varga Date: Wed, 1 Apr 2015 14:43:04 +0200 Subject: [PATCH] Fix AbstractTransactionContext field visibility Make fields final and add proper lifecycle, so we do not have to leak the collection to potential mutators. Change-Id: Ia7c793475c41d3aadf928804f78c39dda2a6b1ef Signed-off-by: Robert Varga --- .../datastore/AbstractTransactionContext.java | 32 +++++++--- .../datastore/NoOpTransactionContext.java | 14 ++--- .../cluster/datastore/TransactionContext.java | 4 +- .../datastore/TransactionContextImpl.java | 59 +++++++++---------- .../cluster/datastore/TransactionProxy.java | 4 +- .../WriteOnlyTransactionContextImpl.java | 2 +- .../PreLithiumTransactionContextImpl.java | 8 +-- 7 files changed, 70 insertions(+), 53 deletions(-) diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractTransactionContext.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractTransactionContext.java index 933e87ace2..d94e1c691e 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractTransactionContext.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/AbstractTransactionContext.java @@ -7,22 +7,40 @@ */ package org.opendaylight.controller.cluster.datastore; -import com.google.common.collect.Lists; +import com.google.common.collect.ImmutableList; +import java.util.ArrayList; +import java.util.Collection; import java.util.List; import org.opendaylight.controller.cluster.datastore.identifiers.TransactionIdentifier; import scala.concurrent.Future; abstract class AbstractTransactionContext implements TransactionContext { - protected final TransactionIdentifier identifier; - protected final List> recordedOperationFutures = Lists.newArrayList(); + private final List> recordedOperationFutures = new ArrayList<>(); + private final TransactionIdentifier identifier; - AbstractTransactionContext(TransactionIdentifier identifier) { + protected AbstractTransactionContext(TransactionIdentifier identifier) { this.identifier = identifier; } @Override - public List> getRecordedOperationFutures() { - return recordedOperationFutures; + public final void copyRecordedOperationFutures(Collection> target) { + target.addAll(recordedOperationFutures); } -} \ No newline at end of file + + protected final TransactionIdentifier getIdentifier() { + return identifier; + } + + protected final Collection> copyRecordedOperationFutures() { + return ImmutableList.copyOf(recordedOperationFutures); + } + + protected final int recordedOperationCount() { + return recordedOperationFutures.size(); + } + + protected final void recordOperationFuture(Future future) { + recordedOperationFutures.add(future); + } +} diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/NoOpTransactionContext.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/NoOpTransactionContext.java index 84f07760f5..672560bbdd 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/NoOpTransactionContext.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/NoOpTransactionContext.java @@ -33,44 +33,44 @@ final class NoOpTransactionContext extends AbstractTransactionContext { @Override public void closeTransaction() { - LOG.debug("NoOpTransactionContext {} closeTransaction called", identifier); + LOG.debug("NoOpTransactionContext {} closeTransaction called", getIdentifier()); } @Override public Future readyTransaction() { - LOG.debug("Tx {} readyTransaction called", identifier); + LOG.debug("Tx {} readyTransaction called", getIdentifier()); operationLimiter.release(); return akka.dispatch.Futures.failed(failure); } @Override public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); + LOG.debug("Tx {} deleteData called path = {}", getIdentifier(), path); operationLimiter.release(); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); + LOG.debug("Tx {} mergeData called path = {}", getIdentifier(), path); operationLimiter.release(); } @Override public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); + LOG.debug("Tx {} writeData called path = {}", getIdentifier(), path); operationLimiter.release(); } @Override public void readData(final YangInstanceIdentifier path, SettableFuture>> proxyFuture) { - LOG.debug("Tx {} readData called path = {}", identifier, path); + LOG.debug("Tx {} readData called path = {}", getIdentifier(), path); operationLimiter.release(); proxyFuture.setException(new ReadFailedException("Error reading data for path " + path, failure)); } @Override public void dataExists(YangInstanceIdentifier path, SettableFuture proxyFuture) { - LOG.debug("Tx {} dataExists called path = {}", identifier, path); + LOG.debug("Tx {} dataExists called path = {}", getIdentifier(), path); operationLimiter.release(); proxyFuture.setException(new ReadFailedException("Error checking exists for path " + path, failure)); } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java index 1b8e65e02d..a5a7494e1a 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContext.java @@ -10,7 +10,7 @@ package org.opendaylight.controller.cluster.datastore; import akka.actor.ActorSelection; import com.google.common.base.Optional; import com.google.common.util.concurrent.SettableFuture; -import java.util.List; +import java.util.Collection; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import scala.concurrent.Future; @@ -34,5 +34,5 @@ interface TransactionContext { void dataExists(YangInstanceIdentifier path, SettableFuture proxyFuture); - List> getRecordedOperationFutures(); + void copyRecordedOperationFutures(Collection> target); } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContextImpl.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContextImpl.java index 3a209630c3..839c6c24d6 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContextImpl.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionContextImpl.java @@ -86,7 +86,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { @Override public void closeTransaction() { - LOG.debug("Tx {} closeTransaction called", identifier); + LOG.debug("Tx {} closeTransaction called", getIdentifier()); actorContext.sendOperationAsync(getActor(), CloseTransaction.INSTANCE.toSerializable()); } @@ -94,7 +94,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { @Override public Future readyTransaction() { LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", - identifier, recordedOperationFutures.size()); + getIdentifier(), recordedOperationCount()); // Send the remaining batched modifications if any. @@ -113,8 +113,8 @@ public class TransactionContextImpl extends AbstractTransactionContext { // Future will fail. We need all prior operations and the ready operation to succeed // in order to attempt commit. - List> futureList = Lists.newArrayListWithCapacity(recordedOperationFutures.size() + 1); - futureList.addAll(recordedOperationFutures); + List> futureList = Lists.newArrayListWithCapacity(recordedOperationCount() + 1); + copyRecordedOperationFutures(futureList); futureList.add(withLastReplyFuture); Future> combinedFutures = akka.dispatch.Futures.sequence(futureList, @@ -127,7 +127,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { @Override public ActorSelection checkedApply(Iterable notUsed) { LOG.debug("Tx {} readyTransaction: pending recorded operations succeeded", - identifier); + getIdentifier()); // At this point all the Futures succeeded and we need to extract the cohort // actor path from the ReadyTransactionReply. For the recorded operations, they @@ -149,7 +149,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { } else { // Throwing an exception here will fail the Future. throw new IllegalArgumentException(String.format("%s: Invalid reply type %s", - identifier, serializedReadyReply.getClass())); + getIdentifier(), serializedReadyReply.getClass())); } } }, TransactionProxy.SAME_FAILURE_TRANSFORMER, actorContext.getClientDispatcher()); @@ -161,7 +161,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { private void batchModification(Modification modification) { if(batchedModifications == null) { - batchedModifications = new BatchedModifications(identifier.toString(), remoteTransactionVersion, + batchedModifications = new BatchedModifications(getIdentifier().toString(), remoteTransactionVersion, transactionChainId); } @@ -176,7 +176,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { private void sendAndRecordBatchedModifications() { Future sentFuture = sendBatchedModifications(); if(sentFuture != null) { - recordedOperationFutures.add(sentFuture); + recordOperationFuture(sentFuture); } } @@ -188,14 +188,14 @@ public class TransactionContextImpl extends AbstractTransactionContext { Future sent = null; if(batchedModifications != null) { if(LOG.isDebugEnabled()) { - LOG.debug("Tx {} sending {} batched modifications, ready: {}", identifier, + LOG.debug("Tx {} sending {} batched modifications, ready: {}", getIdentifier(), batchedModifications.getModifications().size(), ready); } batchedModifications.setReady(ready); sent = executeOperationAsync(batchedModifications); - batchedModifications = new BatchedModifications(identifier.toString(), remoteTransactionVersion, + batchedModifications = new BatchedModifications(getIdentifier().toString(), remoteTransactionVersion, transactionChainId); } @@ -204,21 +204,21 @@ public class TransactionContextImpl extends AbstractTransactionContext { @Override public void deleteData(YangInstanceIdentifier path) { - LOG.debug("Tx {} deleteData called path = {}", identifier, path); + LOG.debug("Tx {} deleteData called path = {}", getIdentifier(), path); batchModification(new DeleteModification(path)); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} mergeData called path = {}", identifier, path); + LOG.debug("Tx {} mergeData called path = {}", getIdentifier(), path); batchModification(new MergeModification(path, data)); } @Override public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - LOG.debug("Tx {} writeData called path = {}", identifier, path); + LOG.debug("Tx {} writeData called path = {}", getIdentifier(), path); batchModification(new WriteModification(path, data)); } @@ -227,7 +227,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { public void readData( final YangInstanceIdentifier path,final SettableFuture>> returnFuture ) { - LOG.debug("Tx {} readData called path = {}", identifier, path); + LOG.debug("Tx {} readData called path = {}", getIdentifier(), path); // Send the remaining batched modifications if any. @@ -237,19 +237,18 @@ public class TransactionContextImpl extends AbstractTransactionContext { // must wait for them to successfully complete. This is necessary to honor the read // uncommitted semantics of the public API contract. If any one fails then fail the read. - if(recordedOperationFutures.isEmpty()) { + if(recordedOperationCount() == 0) { finishReadData(path, returnFuture); } else { LOG.debug("Tx {} readData: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); + getIdentifier(), recordedOperationCount()); // Note: we make a copy of recordedOperationFutures to be on the safe side in case // Futures#sequence accesses the passed List on a different thread, as // recordedOperationFutures is not synchronized. Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), - actorContext.getClientDispatcher()); + copyRecordedOperationFutures(), actorContext.getClientDispatcher()); OnComplete> onComplete = new OnComplete>() { @Override @@ -257,7 +256,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { throws Throwable { if(failure != null) { LOG.debug("Tx {} readData: a recorded operation failed: {}", - identifier, failure); + getIdentifier(), failure); returnFuture.setException(new ReadFailedException( "The read could not be performed because a previous put, merge," + "or delete operation failed", failure)); @@ -275,18 +274,18 @@ public class TransactionContextImpl extends AbstractTransactionContext { private void finishReadData(final YangInstanceIdentifier path, final SettableFuture>> returnFuture) { - LOG.debug("Tx {} finishReadData called path = {}", identifier, path); + LOG.debug("Tx {} finishReadData called path = {}", getIdentifier(), path); OnComplete onComplete = new OnComplete() { @Override public void onComplete(Throwable failure, Object readResponse) throws Throwable { if(failure != null) { - LOG.debug("Tx {} read operation failed: {}", identifier, failure); + LOG.debug("Tx {} read operation failed: {}", getIdentifier(), failure); returnFuture.setException(new ReadFailedException( "Error reading data for path " + path, failure)); } else { - LOG.debug("Tx {} read operation succeeded", identifier, failure); + LOG.debug("Tx {} read operation succeeded", getIdentifier(), failure); if (readResponse instanceof ReadDataReply) { ReadDataReply reply = (ReadDataReply) readResponse; @@ -312,7 +311,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { @Override public void dataExists(final YangInstanceIdentifier path, final SettableFuture returnFuture) { - LOG.debug("Tx {} dataExists called path = {}", identifier, path); + LOG.debug("Tx {} dataExists called path = {}", getIdentifier(), path); // Send the remaining batched modifications if any. @@ -323,18 +322,18 @@ public class TransactionContextImpl extends AbstractTransactionContext { // uncommitted semantics of the public API contract. If any one fails then fail this // request. - if(recordedOperationFutures.isEmpty()) { + if(recordedOperationCount() == 0) { finishDataExists(path, returnFuture); } else { LOG.debug("Tx {} dataExists: verifying {} previous recorded operations", - identifier, recordedOperationFutures.size()); + getIdentifier(), recordedOperationCount()); // Note: we make a copy of recordedOperationFutures to be on the safe side in case // Futures#sequence accesses the passed List on a different thread, as // recordedOperationFutures is not synchronized. Future> combinedFutures = akka.dispatch.Futures.sequence( - Lists.newArrayList(recordedOperationFutures), + copyRecordedOperationFutures(), actorContext.getClientDispatcher()); OnComplete> onComplete = new OnComplete>() { @Override @@ -342,7 +341,7 @@ public class TransactionContextImpl extends AbstractTransactionContext { throws Throwable { if(failure != null) { LOG.debug("Tx {} dataExists: a recorded operation failed: {}", - identifier, failure); + getIdentifier(), failure); returnFuture.setException(new ReadFailedException( "The data exists could not be performed because a previous " + "put, merge, or delete operation failed", failure)); @@ -359,17 +358,17 @@ public class TransactionContextImpl extends AbstractTransactionContext { private void finishDataExists(final YangInstanceIdentifier path, final SettableFuture returnFuture) { - LOG.debug("Tx {} finishDataExists called path = {}", identifier, path); + LOG.debug("Tx {} finishDataExists called path = {}", getIdentifier(), path); OnComplete onComplete = new OnComplete() { @Override public void onComplete(Throwable failure, Object response) throws Throwable { if(failure != null) { - LOG.debug("Tx {} dataExists operation failed: {}", identifier, failure); + LOG.debug("Tx {} dataExists operation failed: {}", getIdentifier(), failure); returnFuture.setException(new ReadFailedException( "Error checking data exists for path " + path, failure)); } else { - LOG.debug("Tx {} dataExists operation succeeded", identifier, failure); + LOG.debug("Tx {} dataExists operation succeeded", getIdentifier(), failure); if (response instanceof DataExistsReply) { returnFuture.set(Boolean.valueOf(((DataExistsReply) response).exists())); diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java index 7eabf9e9a6..b0817e06ff 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/TransactionProxy.java @@ -224,8 +224,8 @@ public class TransactionProxy extends AbstractDOMStoreTransaction> recordedOperationFutures = Lists.newArrayList(); for(TransactionFutureCallback txFutureCallback : txFutureCallbackMap.values()) { TransactionContext transactionContext = txFutureCallback.getTransactionContext(); - if(transactionContext != null) { - recordedOperationFutures.addAll(transactionContext.getRecordedOperationFutures()); + if (transactionContext != null) { + transactionContext.copyRecordedOperationFutures(recordedOperationFutures); } } diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/WriteOnlyTransactionContextImpl.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/WriteOnlyTransactionContextImpl.java index 3b4a190a9e..e1313540c4 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/WriteOnlyTransactionContextImpl.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/WriteOnlyTransactionContextImpl.java @@ -33,7 +33,7 @@ public class WriteOnlyTransactionContextImpl extends TransactionContextImpl { @Override public Future readyTransaction() { LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", - identifier, recordedOperationFutures.size()); + getIdentifier(), recordedOperationCount()); // Send the remaining batched modifications if any. diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/compat/PreLithiumTransactionContextImpl.java b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/compat/PreLithiumTransactionContextImpl.java index ccfb329692..c3450333a4 100644 --- a/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/compat/PreLithiumTransactionContextImpl.java +++ b/opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/compat/PreLithiumTransactionContextImpl.java @@ -45,26 +45,26 @@ public class PreLithiumTransactionContextImpl extends TransactionContextImpl { @Override public void deleteData(YangInstanceIdentifier path) { - recordedOperationFutures.add(executeOperationAsync( + recordOperationFuture(executeOperationAsync( new DeleteData(path, getRemoteTransactionVersion()))); } @Override public void mergeData(YangInstanceIdentifier path, NormalizedNode data) { - recordedOperationFutures.add(executeOperationAsync( + recordOperationFuture(executeOperationAsync( new MergeData(path, data, getRemoteTransactionVersion()))); } @Override public void writeData(YangInstanceIdentifier path, NormalizedNode data) { - recordedOperationFutures.add(executeOperationAsync( + recordOperationFuture(executeOperationAsync( new WriteData(path, data, getRemoteTransactionVersion()))); } @Override public Future readyTransaction() { LOG.debug("Tx {} readyTransaction called with {} previous recorded operations pending", - identifier, recordedOperationFutures.size()); + getIdentifier(), recordedOperationCount()); // Send the ReadyTransaction message to the Tx actor. -- 2.36.6