HONEYCOMB-10: Add specific methods for each request to Future facade

These specific methods remove the need for casting on client
side code while using generic send method

Change-Id: Ic0240359333831b676a7d205f63ac1c3f3f8af4c
Signed-off-by: Maros Marsalek <mmarsale@cisco.com>

3 files changed, 18 insertions, 17 deletions

diff --git a/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVpp.java b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvoker.java
index d860bc2d483..8dab7f5e42d 100644
--- a/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVpp.java
+++ b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvoker.java
@@ -24,7 +24,7 @@ import org.openvpp.jvpp.dto.JVppRequest;
 /**
 * Future facade on top of JVpp
 */
-public interface FutureJVpp {
+public interface FutureJVppInvoker extends AutoCloseable {
 
     /**
      * Invoke asynchronous operation on VPP
diff --git a/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppFacade.java b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java
index 5b8222c4565..ef8b13c5b01 100644
--- a/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppFacade.java
+++ b/vpp-api/java/jvpp/org/openvpp/jvpp/future/FutureJVppInvokerFacade.java
@@ -30,7 +30,7 @@ import org.openvpp.jvpp.dto.JVppRequest;
 /**
 * Future facade on top of JVpp
 */
-public final class FutureJVppFacade implements FutureJVpp {
+public class FutureJVppInvokerFacade implements FutureJVppInvoker {
 
     private final JVpp jvpp;
 
@@ -39,7 +39,7 @@ public final class FutureJVppFacade implements FutureJVpp {
      */
     private final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requests;
 
-    public FutureJVppFacade(final JVpp jvpp,
+    public FutureJVppInvokerFacade(final JVpp jvpp,
                      final Map<Integer, CompletableFuture<? extends JVppReply<?>>> requestMap) {
         // TODO use guava's preconditions for nonNull and state checks
         // However adding guava as a dependency requires better build system for Java in VPP project
@@ -81,12 +81,9 @@ public final class FutureJVppFacade implements FutureJVpp {
     }
 
     static final class CompletableDumpFuture<T extends JVppReplyDump<?, ?>> extends CompletableFuture<T> {
-        // TODO make this final
         // The reason why this is not final is the instantiation of ReplyDump DTOs
         // Their instantiation must be generated, so currently the DTOs are created in callback and set when first dump reponses
-        // is returned. Because in callback we have method per response, but here where requests are invoked there is only
-        // a single generic send method that does not have enough information to create the DTO
-        // This can be final as soon as we provide specific send methods here
+        // is handled in the callback.
         private T replyDump;
         private final long contextId;
 
@@ -107,4 +104,8 @@ public final class FutureJVppFacade implements FutureJVpp {
         }
     }
 
+    @Override
+    public void close() throws Exception {
+        // NOOP
+    }
 }
diff --git a/vpp-api/java/jvpp/org/openvpp/jvpp/test/FutureApiTest.java b/vpp-api/java/jvpp/org/openvpp/jvpp/test/FutureApiTest.java
index b5b36d58015..eb28bbc2e4d 100644
--- a/vpp-api/java/jvpp/org/openvpp/jvpp/test/FutureApiTest.java
+++ b/vpp-api/java/jvpp/org/openvpp/jvpp/test/FutureApiTest.java
@@ -37,8 +37,8 @@ public class FutureApiTest {
     private static void testShowVersion(final FutureJVppFacade jvpp) {
         System.out.println("Sending ShowVersion request...");
         try {
-            final Future<JVppReply<ShowVersion>> replyFuture = jvpp.send(new ShowVersion()).toCompletableFuture();
-            final ShowVersionReply reply = (ShowVersionReply) replyFuture.get(); // TODO can we get rid of that cast?
+            final Future<ShowVersionReply> replyFuture = jvpp.showVersion(new ShowVersion()).toCompletableFuture();
+            final ShowVersionReply reply = replyFuture.get();
             System.out.printf("Received ShowVersionReply: context=%d, retval=%d, program=%s, " +
                             "version=%s, buildDate=%s, buildDirectory=%s\n",
                     reply.context, reply.retval, new String(reply.program), new String(reply.version),
@@ -58,8 +58,8 @@ public class FutureApiTest {
         try {
             final GetNodeIndex request = new GetNodeIndex();
             request.nodeName = "node0".getBytes();
-            final Future<JVppReply<GetNodeIndex>> replyFuture = jvpp.send(request).toCompletableFuture();
-            final GetNodeIndexReply reply = (GetNodeIndexReply) replyFuture.get();
+            final Future<GetNodeIndexReply> replyFuture = jvpp.getNodeIndex(request).toCompletableFuture();
+            final GetNodeIndexReply reply = replyFuture.get();
             System.out.printf("Received GetNodeIndexReply: context=%d, retval=%d, nodeIndex=%d\n",
                     reply.context, reply.retval, reply.nodeIndex);
         } catch (Exception e) {
@@ -74,8 +74,8 @@ public class FutureApiTest {
             final SwInterfaceDump request = new SwInterfaceDump();
             request.nameFilterValid = 0;
             request.nameFilter = "".getBytes();
-            final Future<JVppReply<SwInterfaceDump>> replyFuture = jvpp.send(request).toCompletableFuture();
-            final SwInterfaceDetailsReplyDump reply = (SwInterfaceDetailsReplyDump) replyFuture.get();
+            final Future<SwInterfaceDetailsReplyDump> replyFuture = jvpp.swInterfaceDump(request).toCompletableFuture();
+            final SwInterfaceDetailsReplyDump reply = replyFuture.get();
 
             if (reply == null) {
                 throw new IllegalStateException("SwInterfaceDetailsReplyDump is null!");
@@ -106,12 +106,12 @@ public class FutureApiTest {
         final Map<Integer, CompletableFuture<? extends JVppReply<?>>>  map = new HashMap<>();
         final org.openvpp.jvpp.JVppImpl impl =
                 new org.openvpp.jvpp.JVppImpl(VppJNIConnection.create("FutureApiTest", new FutureJVppFacadeCallback(map)));
-        final FutureJVppFacade jvpp = new FutureJVppFacade(impl, map);
+        final FutureJVppFacade jvppFacade = new FutureJVppFacade(impl, map);
         System.out.println("Successfully connected to VPP");
 
-        testShowVersion(jvpp);
-        testGetNodeIndex(jvpp);
-        testSwInterfaceDump(jvpp);
+        testShowVersion(jvppFacade);
+        testGetNodeIndex(jvppFacade);
+        testSwInterfaceDump(jvppFacade);
 
         System.out.println("Disconnecting...");
         // TODO we should consider adding jvpp.close(); to the facade