org.elastos.hive

Class ScriptRunner

java.lang.Object

org.elastos.hive.connection.NodeRPCConnection

org.elastos.hive.ServiceEndpoint

org.elastos.hive.ScriptRunner

All Implemented Interfaces:

ScriptingInvocationService

public class ScriptRunner
extends ServiceEndpoint
implements ScriptingInvocationService

The script runner is used on the script calling side.

To call the script, the script owner need register the script first.

                Vault vault = new Vault(appContext, providerAddress);
                ScriptingService scriptingService = vault.getScriptingService();
                scriptingService.registerScript(...);
 

Then the script caller can use this class to execute the script.

                ScriptRunner scriptRunner = new ScriptRunner(callerAppContext, providerAddress);
                scriptRunner.callScript(...).get();
 

Constructor Summary

Constructors

Constructor and Description
ScriptRunner(AppContext context, java.lang.String providerAddress)

Method Summary

Modifier and Type	Method and Description
<T> java.util.concurrent.CompletableFuture<T>	callScript(java.lang.String name, com.fasterxml.jackson.databind.JsonNode params, java.lang.String targetDid, java.lang.String targetAppDid, java.lang.Class<T> resultType) Invoke the execution of a specified script registered previously by the vault owner, where the script is defined with certain preset routines.
<T> java.util.concurrent.CompletableFuture<T>	callScriptUrl(java.lang.String name, java.lang.String params, java.lang.String targetDid, java.lang.String targetAppDid, java.lang.Class<T> resultType) Executes a previously registered server side script with a direct URL where the values can be passed as part of the query.
<T> java.util.concurrent.CompletableFuture<T>	downloadFile(java.lang.String transactionId, java.lang.Class<T> resultType) Invoke the execution of the script to download a file in the streaming mode.
<T> java.util.concurrent.CompletableFuture<T>	uploadFile(java.lang.String transactionId, java.lang.Class<T> resultType) Invoke the execution of the script to upload a file in the streaming mode.

Methods inherited from class org.elastos.hive.ServiceEndpoint

getAccessToken, getAppContext, getAppDid, getAppInstanceDid, getLatestCommitId, getNodeVersion, getProviderAddress, getServiceDid, getServiceInstanceDid, getStorage, getUserDid, refreshAccessToken

Methods inherited from class org.elastos.hive.connection.NodeRPCConnection

createService, openConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScriptRunner

public ScriptRunner(AppContext context,
                    java.lang.String providerAddress)

Method Detail

callScript

public <T> java.util.concurrent.CompletableFuture<T> callScript(java.lang.String name,
                                                                com.fasterxml.jackson.databind.JsonNode params,
                                                                java.lang.String targetDid,
                                                                java.lang.String targetAppDid,
                                                                java.lang.Class<T> resultType)

Description copied from interface: ScriptingInvocationService

Invoke the execution of a specified script registered previously by the vault owner, where the script is defined with certain preset routines. It's the general invocation method for external users to call.

Specified by:

callScript in interface ScriptingInvocationService

Type Parameters:

T - String, byte[], JsonNode, Reader

Parameters:

name - The name of script to invoke.

params - The parameters as input to the invocation.

targetDid - The script owner's user did. Skipped when owner calls.

targetAppDid - The script owner's application did. Skipped when owner calls.

resultType - String, byte[], JsonNode, Reader

Returns:

String, byte[], JsonNode, Reader

callScriptUrl

public <T> java.util.concurrent.CompletableFuture<T> callScriptUrl(java.lang.String name,
                                                                   java.lang.String params,
                                                                   java.lang.String targetDid,
                                                                   java.lang.String targetAppDid,
                                                                   java.lang.Class<T> resultType)

Executes a previously registered server side script with a direct URL where the values can be passed as part of the query. Vault owner or external users are allowed to call scripts on someone's vault.

Type Parameters:

T - String, byte[], JsonNode, Reader, Write, OutputStream, Reader, InputStream

Parameters:

name - The call's script name

params - The parameters for the script.

targetDid - The script owner's user did.

targetAppDid - The script owner's application did.

resultType - String, byte[], JsonNode, Reader, Write, OutputStream, Reader, InputStream

Returns:

Result for specific script type

downloadFile

public <T> java.util.concurrent.CompletableFuture<T> downloadFile(java.lang.String transactionId,
                                                                  java.lang.Class<T> resultType)

Description copied from interface: ScriptingInvocationService

Invoke the execution of the script to download a file in the streaming mode. The upload works a bit differently from other executable queries because there are two steps to this executable. First, register a script on the vault, then you call this API actually to download the file

Specified by:

downloadFile in interface ScriptingInvocationService

Type Parameters:

T - Reader or InputStream class

Parameters:

transactionId - The streaming identifier to the upload process

resultType - Reader or InputStream class

Returns:

Reader or InputStream class

uploadFile

public <T> java.util.concurrent.CompletableFuture<T> uploadFile(java.lang.String transactionId,
                                                                java.lang.Class<T> resultType)

Description copied from interface: ScriptingInvocationService

Invoke the execution of the script to upload a file in the streaming mode. The upload works a bit differently from other executable queries because there are two steps to this executable. First, register a script on the vault, then you call this API actually to upload the file

Specified by:

uploadFile in interface ScriptingInvocationService

Type Parameters:

T - Reader or InputStream class

Parameters:

transactionId - The streaming identifier to the upload process

resultType - Reader or InputStream class

Returns:

Reader or InputStream class