org.elastos.hive.service

Interface ScriptingInvocationService

All Known Subinterfaces:

ScriptingService

All Known Implementing Classes:

ScriptRunner

public interface ScriptingInvocationService

Vault provides the scripting service to general users to execute a preset script by the vault owner.

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>	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.

Method Detail

callScript

<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. It's the general invocation method for external users to call.

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

uploadFile

<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. 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

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

downloadFile

<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. 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

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