Deprecate DOMDataTreeProducer-related classes

[controller.git] / opendaylight / md-sal / samples / clustering-test-app / provider / src / main / java / org / opendaylight / controller / clustering / it / provider / impl / ProduceTransactionsHandler.java

diff --git a/opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/ProduceTransactionsHandler.java b/opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/ProduceTransactionsHandler.java
index b1348c2fc42c2fc03f6be77bb9aafe9de864d734..fc1c9f5545b80ed8509b87c3e58dc36033447663 100644 (file)
--- a/opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/ProduceTransactionsHandler.java
+++ b/opendaylight/md-sal/samples/clustering-test-app/provider/src/main/java/org/opendaylight/controller/clustering/it/provider/impl/ProduceTransactionsHandler.java
@@ -5,10 +5,11 @@
  * 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.clustering.it.provider.impl;
 
-import com.google.common.base.Preconditions;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.util.concurrent.FluentFuture;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.common.util.concurrent.SettableFuture;
@@ -16,7 +17,11 @@ import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
 import java.util.SplittableRandom;
+import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.mdsal.common.api.CommitInfo;
 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
 import org.opendaylight.mdsal.dom.api.DOMDataTreeCursorAwareTransaction;
 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
@@ -38,7 +43,8 @@ import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class ProduceTransactionsHandler extends AbstractTransactionHandler {
+@Deprecated(forRemoval = true)
+public final class ProduceTransactionsHandler extends AbstractTransactionHandler {
     private static final Logger LOG = LoggerFactory.getLogger(ProduceTransactionsHandler.class);
 
     private final SettableFuture<RpcResult<ProduceTransactionsOutput>> future = SettableFuture.create();
@@ -53,8 +59,8 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
     private ProduceTransactionsHandler(final DOMDataTreeProducer producer, final DOMDataTreeIdentifier idListItem,
             final ProduceTransactionsInput input) {
         super(input);
-        this.itemProducer = Preconditions.checkNotNull(producer);
-        this.idListItem = Preconditions.checkNotNull(idListItem);
+        this.itemProducer = requireNonNull(producer);
+        this.idListItem = requireNonNull(idListItem);
     }
 
     public static ListenableFuture<RpcResult<ProduceTransactionsOutput>> start(
@@ -62,7 +68,7 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
         final String id = input.getId();
         LOG.debug("Filling the item list {} with initial values.", id);
 
-        final YangInstanceIdentifier idListWithKey = ID_INT_YID.node(new NodeIdentifierWithPredicates(ID_INT, ID, id));
+        final YangInstanceIdentifier idListWithKey = ID_INT_YID.node(NodeIdentifierWithPredicates.of(ID_INT, ID, id));
 
         final DOMDataTreeProducer itemProducer = domDataTreeService.createProducer(
             Collections.singleton(new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, idListWithKey)));
@@ -76,15 +82,10 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
         cursor.close();
 
         try {
-            tx.submit().checkedGet(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
-        } catch (final Exception e) {
+            tx.commit().get(INIT_TX_TIMEOUT_SECONDS, TimeUnit.SECONDS);
+        } catch (InterruptedException | ExecutionException | TimeoutException e) {
             LOG.warn("Unable to fill the initial item list.", e);
-
-            try {
-                itemProducer.close();
-            } catch (final DOMDataTreeProducerException exception) {
-                LOG.warn("Failure while closing producer.", exception);
-            }
+            closeProducer(itemProducer);
 
             return Futures.immediateFuture(RpcResultBuilder.<ProduceTransactionsOutput>failed()
                 .withError(RpcError.ErrorType.APPLICATION, "Unexpected-exception", e).build());
@@ -93,17 +94,26 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
         final ProduceTransactionsHandler handler = new ProduceTransactionsHandler(itemProducer,
             new DOMDataTreeIdentifier(LogicalDatastoreType.CONFIGURATION, idListWithKey.node(list.getIdentifier())
                 .toOptimized()), input);
+        // It is handler's responsibility to close itemProducer when the work is finished.
         handler.doStart();
         return handler.future;
     }
 
+    private static void closeProducer(final DOMDataTreeProducer producer) {
+        try {
+            producer.close();
+        } catch (final DOMDataTreeProducerException exception) {
+            LOG.warn("Failure while closing producer.", exception);
+        }
+    }
+
     @Override
-    ListenableFuture<Void> execWrite(final long txId) {
+    FluentFuture<? extends @NonNull CommitInfo> execWrite(final long txId) {
         final int i = random.nextInt(MAX_ITEM + 1);
         final DOMDataTreeCursorAwareTransaction tx = itemProducer.createTransaction(false);
         final DOMDataTreeWriteCursor cursor = tx.createCursor(idListItem);
 
-        final NodeIdentifierWithPredicates entryId = new NodeIdentifierWithPredicates(ITEM, NUMBER, i);
+        final NodeIdentifierWithPredicates entryId = NodeIdentifierWithPredicates.of(ITEM, NUMBER, i);
         if (usedValues.contains(i)) {
             LOG.debug("Deleting item: {}", i);
             deleteTx++;
@@ -122,17 +132,19 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
 
         cursor.close();
 
-        return tx.submit();
+        return tx.commit();
     }
 
     @Override
-    void runFailed(final Throwable cause) {
+    void runFailed(final Throwable cause, final long txId) {
+        closeProducer(itemProducer);
         future.set(RpcResultBuilder.<ProduceTransactionsOutput>failed()
-            .withError(RpcError.ErrorType.APPLICATION, "Submit failed", cause).build());
+            .withError(RpcError.ErrorType.APPLICATION, "Commit failed for tx # " + txId, cause).build());
     }
 
     @Override
     void runSuccessful(final long allTx) {
+        closeProducer(itemProducer);
         final ProduceTransactionsOutput output = new ProduceTransactionsOutputBuilder()
                 .setAllTx(allTx)
                 .setInsertTx(insertTx)
@@ -143,9 +155,9 @@ public class ProduceTransactionsHandler extends AbstractTransactionHandler {
     }
 
     @Override
-    void runTimedOut(final Exception cause) {
+    void runTimedOut(final String cause) {
+        closeProducer(itemProducer);
         future.set(RpcResultBuilder.<ProduceTransactionsOutput>failed()
-            .withError(RpcError.ErrorType.APPLICATION,
-                    "Final submit was timed out by the test provider or was interrupted", cause).build());
+            .withError(RpcError.ErrorType.APPLICATION, cause).build());
     }
 }