External api proposal

[openflowplugin.git] / openflowplugin / src / main / java / org / opendaylight / openflowplugin / openflow / md / core / sal / OFRpcTaskUtil.java

diff --git a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskUtil.java b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskUtil.java
index 7566f04fd48ed24e989df0abc0896c2238c6aaf9..53f7a8626006bc3f1cfa3cb4c0baba8a574445fc 100644 (file)
--- a/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskUtil.java
+++ b/openflowplugin/src/main/java/org/opendaylight/openflowplugin/openflow/md/core/sal/OFRpcTaskUtil.java
@@ -18,11 +18,10 @@ import org.opendaylight.openflowplugin.api.OFConstants;
 import org.opendaylight.openflowplugin.api.openflow.md.core.SwitchConnectionDistinguisher;
 import org.opendaylight.openflowplugin.api.openflow.md.core.sal.NotificationComposer;
 import org.opendaylight.openflowplugin.api.statistics.MessageSpy;
-import org.opendaylight.openflowplugin.openflow.md.core.MessageFactory;
-import org.opendaylight.openflowplugin.api.openflow.md.core.session.IMessageDispatchService;
-import org.opendaylight.openflowplugin.api.openflow.md.core.session.SessionContext;
 import org.opendaylight.openflowplugin.openflow.md.util.RpcInputOutputTuple;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev131103.TransactionAware;
+import org.opendaylight.openflowplugin.openflow.md.util.TaskUtil;
+
+import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierInput;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.BarrierOutput;
 import org.opendaylight.yangtools.yang.binding.DataContainer;
@@ -40,7 +39,6 @@ import com.google.common.collect.Lists;
 import com.google.common.util.concurrent.AsyncFunction;
 import com.google.common.util.concurrent.FutureCallback;
 import com.google.common.util.concurrent.Futures;
-import com.google.common.util.concurrent.JdkFutureAdapters;
 import com.google.common.util.concurrent.ListenableFuture;
 
 /**
@@ -54,12 +52,16 @@ public abstract class OFRpcTaskUtil {
      * @param cookie
      * @return rpcResult of given type, containing wrapped errors of barrier sending (if any) or success
      */
+    private OFRpcTaskUtil() {
+        //hiding implicit constructor
+    }
+
     public static Collection<RpcError> manageBarrier(OFRpcTaskContext taskContext, Boolean isBarrier,
             SwitchConnectionDistinguisher cookie) {
         Collection<RpcError> errors = null;
         if (Objects.firstNonNull(isBarrier, Boolean.FALSE)) {
             RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrierRpc =
-                    sendBarrier(taskContext.getSession(), cookie, taskContext.getMessageService());
+                    TaskUtil.sendBarrier(taskContext.getSession(), cookie, taskContext.getMessageService());
             Future<RpcResult<BarrierOutput>> barrierFuture = sendBarrierRpc.getOutput();
             try {
                 RpcResult<BarrierOutput> barrierResult = barrierFuture.get(
@@ -86,35 +88,20 @@ public abstract class OFRpcTaskUtil {
         return errors;
     }
 
-    /**
-     * @param session
-     * @param cookie
-     * @param messageService
-     * @return barrier response
-     */
-    protected static RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrier(SessionContext session,
-            SwitchConnectionDistinguisher cookie, IMessageDispatchService messageService) {
-        BarrierInput barrierInput = MessageFactory.createBarrier(
-                session.getFeatures().getVersion(), session.getNextXid());
-        Future<RpcResult<BarrierOutput>> barrierResult = messageService.barrier(barrierInput, cookie);
-        ListenableFuture<RpcResult<BarrierOutput>> output = JdkFutureAdapters.listenInPoolThread(barrierResult);
-
-        return new RpcInputOutputTuple<>(barrierInput, output);
-    }
-
     /**
      * @param task of rpc
      * @param originalResult
      * @param notificationProviderService
      * @param notificationComposer lazy notification composer
      */
-    public static <R extends RpcResult<? extends TransactionAware>, N extends Notification, INPUT extends DataContainer>
+    public static <R extends RpcResult<? extends TransactionAware>, N extends Notification, I extends DataContainer>
     void hookFutureNotification(
-            final OFRpcTask<INPUT, R> task,
+            final OFRpcTask<I, R> task,
             ListenableFuture<R> originalResult,
             final NotificationProviderService notificationProviderService,
             final NotificationComposer<N> notificationComposer) {
-        Futures.addCallback(originalResult, new FutureCallback<R>() {
+
+        class FutureCallbackImpl implements FutureCallback<R> {
             @Override
             public void onSuccess(R result) {
                 if(null == notificationProviderService) {
@@ -140,7 +127,9 @@ public abstract class OFRpcTaskUtil {
                 task.getTaskContext().getMessageSpy().spyMessage(
                         task.getInput(), MessageSpy.STATISTIC_GROUP.TO_SWITCH_SUBMITTED_FAILURE);
             }
-        });
+        }
+
+        Futures.addCallback(originalResult, new FutureCallbackImpl());
     }
 
     /**
@@ -150,22 +139,22 @@ public abstract class OFRpcTaskUtil {
      * @param notificationComposer lazy notification composer
      * @return chained result with barrier
      */
-    public static <TX extends TransactionAware, INPUT extends DataContainer>
-    ListenableFuture<RpcResult<TX>> chainFutureBarrier(
-            final OFRpcTask<INPUT, RpcResult<TX>> task,
-            final ListenableFuture<RpcResult<TX>> originalResult) {
+    public static <T extends TransactionAware, I extends DataContainer>
+    ListenableFuture<RpcResult<T>> chainFutureBarrier(
+            final OFRpcTask<I, RpcResult<T>> task,
+            final ListenableFuture<RpcResult<T>> originalResult) {
 
-        ListenableFuture<RpcResult<TX>> chainResult = originalResult;
+        ListenableFuture<RpcResult<T>> chainResult = originalResult;
         if (Objects.firstNonNull(task.isBarrier(), Boolean.FALSE)) {
 
-            chainResult = Futures.transform(originalResult, new AsyncFunction<RpcResult<TX>, RpcResult<TX>>() {
+            chainResult = Futures.transform(originalResult, new AsyncFunction<RpcResult<T>, RpcResult<T>>() {
 
                 @Override
-                public ListenableFuture<RpcResult<TX>> apply(final RpcResult<TX> input) throws Exception {
+                public ListenableFuture<RpcResult<T>> apply(final RpcResult<T> input) throws Exception {
                     if (input.isSuccessful()) {
-                        RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrierRpc = sendBarrier(
+                        RpcInputOutputTuple<BarrierInput, ListenableFuture<RpcResult<BarrierOutput>>> sendBarrierRpc = TaskUtil.sendBarrier(
                                 task.getSession(), task.getCookie(), task.getMessageService());
-                        ListenableFuture<RpcResult<TX>> barrierTxResult = Futures.transform(
+                        ListenableFuture<RpcResult<T>> barrierTxResult = Futures.transform(
                                 sendBarrierRpc.getOutput(),
                                 transformBarrierToTransactionAware(input, sendBarrierRpc.getInput()));
                         return barrierTxResult;
@@ -184,17 +173,18 @@ public abstract class OFRpcTaskUtil {
      * @param originalInput
      * @return
      */
-    protected static <TX extends TransactionAware> Function<RpcResult<BarrierOutput>, RpcResult<TX>> transformBarrierToTransactionAware(
-            final RpcResult<TX> originalInput, final BarrierInput barrierInput) {
-        return new Function<RpcResult<BarrierOutput>, RpcResult<TX>>() {
+    protected static <T extends TransactionAware> Function<RpcResult<BarrierOutput>, RpcResult<T>> transformBarrierToTransactionAware(
+            final RpcResult<T> originalInput, final BarrierInput barrierInput) {
+
+        class FunctionImpl implements Function<RpcResult<BarrierOutput>, RpcResult<T>> {
 
             @Override
-            public RpcResult<TX> apply(final RpcResult<BarrierOutput> barrierResult) {
-                RpcResultBuilder<TX> rpcBuilder = null;
+            public RpcResult<T> apply(final RpcResult<BarrierOutput> barrierResult) {
+                RpcResultBuilder<T> rpcBuilder = null;
                 if (barrierResult.isSuccessful()) {
-                    rpcBuilder = RpcResultBuilder.<TX>success();
+                    rpcBuilder = RpcResultBuilder.<T>success();
                 } else {
-                    rpcBuilder = RpcResultBuilder.<TX>failed();
+                    rpcBuilder = RpcResultBuilder.<T>failed();
                     RpcError rpcError = RpcResultBuilder.newWarning(
                             ErrorType.RPC,
                             OFConstants.ERROR_TAG_TIMEOUT,
@@ -212,7 +202,8 @@ public abstract class OFRpcTaskUtil {
 
                 return rpcBuilder.build();
             }
+        }
 
-        };
+        return new FunctionImpl();
     }
 }