org.elastos.hive

Interface Scripting

public interface Scripting

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 appDid, java.lang.Class<T> resultType) Executes a previously registered server side script using Scripting.setScript().
<T> java.util.concurrent.CompletableFuture<T>	callScriptUrl(java.lang.String name, java.lang.String params, java.lang.String appDid, 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) Run a script to download a file NOTE: The download works a bit differently compared to other types of executable queries because there are two steps to this executable.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	registerScript(java.lang.String name, Condition condition, Executable executable, boolean allowAnonymousUser, boolean allowAnonymousApp)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	registerScript(java.lang.String name, Executable executable, boolean allowAnonymousUser, boolean allowAnonymousApp) Lets the vault owner register a script on his vault for a given app.
<T> java.util.concurrent.CompletableFuture<T>	uploadFile(java.lang.String transactionId, java.lang.Class<T> resultType) Run a script to upload a file NOTE: The upload works a bit differently compared to other types of executable queries because there are two steps to this executable.

Method Detail

registerScript

java.util.concurrent.CompletableFuture<java.lang.Boolean> registerScript(java.lang.String name,
                                                                         Executable executable,
                                                                         boolean allowAnonymousUser,
                                                                         boolean allowAnonymousApp)

Lets the vault owner register a script on his vault for a given app. The script is built on the client side, then serialized and stored on the hive back-end. Later on, anyone, including the vault owner or external users, can use Scripting.call() to execute one of those scripts and get results/data.

registerScript

java.util.concurrent.CompletableFuture<java.lang.Boolean> registerScript(java.lang.String name,
                                                                         Condition condition,
                                                                         Executable executable,
                                                                         boolean allowAnonymousUser,
                                                                         boolean allowAnonymousApp)

callScript

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

Executes a previously registered server side script using Scripting.setScript(). Vault owner or external users are allowed to call scripts on someone's vault.

Type Parameters:

T - String, byte[], JsonNode, Reader

Parameters:

name - the call's script name

resultType - String, byte[], JsonNode, Reader

Returns:

callScriptUrl

<T> java.util.concurrent.CompletableFuture<T> callScriptUrl(java.lang.String name,
                                                            java.lang.String params,
                                                            java.lang.String appDid,
                                                            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

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

Returns:

uploadFile

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

Run a script to upload a file NOTE: The upload works a bit differently compared to other types of executable queries because there are two steps to this executable. First, register a script on the vault, then you call this api to actually upload the file

Type Parameters:

T - Write, OutputStream

Parameters:

transactionId -

resultType - Write, OutputStream

Returns:

downloadFile

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

Run a script to download a file NOTE: The download works a bit differently compared to other types of executable queries because there are two steps to this executable. First, register a script on the vault, then you call this api to actually upload the file

Type Parameters:

T - Reader

Parameters:

resultType - Reader or InputStream class

Returns: