Add interface methods for delegated subscriptions

TIHBS · Jan 11, 2023 · c21c3e3 · c21c3e3
1 parent f41f782
commit c21c3e3
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 2 deletions.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>blockchains.iaas.uni.stuttgart.de</groupId>
     <artifactId>blockchain-access-layer-api</artifactId>
-    <version>2.0.3</version>
+    <version>2.0.4</version>
 
     <properties>
         <maven.compiler.source>8</maven.compiler.source>

diff --git a/src/main/java/blockchains/iaas/uni/stuttgart/de/api/interfaces/BlockchainAdapter.java b/src/main/java/blockchains/iaas/uni/stuttgart/de/api/interfaces/BlockchainAdapter.java
@@ -1,7 +1,8 @@
 /********************************************************************************
- * Copyright (c) 2018-2022 Institute for the Architecture of Application System -
+ * Copyright (c) 2018-2023 Institute for the Architecture of Application System -
  * University of Stuttgart
  * Author: Ghareeb Falazi
+ * Co-author: Akshay Patel
  *
  * This program and the accompanying materials are made available under the
  * terms the Apache Software License 2.0
@@ -16,6 +17,8 @@
 import blockchains.iaas.uni.stuttgart.de.api.exceptions.InvalidTransactionException;
 import blockchains.iaas.uni.stuttgart.de.api.exceptions.NotSupportedException;
 import blockchains.iaas.uni.stuttgart.de.api.model.*;
+import com.github.arteam.simplejsonrpc.core.annotation.JsonRpcOptional;
+import com.github.arteam.simplejsonrpc.core.annotation.JsonRpcParam;
 import io.reactivex.Observable;
 
 import java.math.BigDecimal;
@@ -147,4 +150,33 @@ CompletableFuture<Transaction> tryReplaceInvocation(String correlationId, String
 
     boolean tryCancelInvocation(String correlationId);
 
+    /*
+     * This method should be implemented by the plugin to indicate whether the plugin is capable of handling subscription
+     * and the callbacks both.
+     * */
+    boolean canHandleDelegatedSubscription();
+
+    /*
+     * This method is an alternative to initial gateway implementation where the gateway acts as a centralized entity
+     * and handles subscriptions and callbacks. Using this method, a plugin can must invoke callbacks on its own rather
+     * than gateway managing the callbacks.
+     * */
+    boolean delegatedSubscribe(String functionIdentifier,
+                               String eventIdentifier,
+                               List<Parameter> outputParameters,
+                               double degreeOfConfidence,
+                               String filter,
+                               String callbackUrl,
+                               String correlationId);
+
+    /*
+     * This method is an alternative to initial gateway implementation where the gateway acts as a centralized entity
+     * and handles subscriptions, callbacks and cancelling subscriptions.
+     * */
+    boolean delegatedUnsubscribe(String functionIdentifier,
+                                 String eventIdentifier,
+                                 List<String> typeArguments,
+                                 List<Parameter> parameters,
+                                 String correlationId);
+
 }