org.elastos.hive.service

Interface ScriptingService

All Superinterfaces:

ScriptingInvocationService

public interface ScriptingService
extends ScriptingInvocationService

Vault provides the scripting service to vault owners to register executable script and make invocation as well. The executable script registered by the vault owner mainly serves external users to invoke for executing the preset routine defined in the script.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Void>	registerScript(java.lang.String name, Condition condition, Executable executable)
java.util.concurrent.CompletableFuture<java.lang.Void>	registerScript(java.lang.String name, Condition condition, Executable executable, boolean allowAnonymousUser, boolean allowAnonymousApp) Let the vault owner register a script on his vault for a given application.
java.util.concurrent.CompletableFuture<java.lang.Void>	registerScript(java.lang.String name, Executable executable)
java.util.concurrent.CompletableFuture<java.lang.Void>	registerScript(java.lang.String name, Executable executable, boolean allowAnonymousUser, boolean allowAnonymousApp) Lets the vault owner register a script on his vault for a given application.
java.util.concurrent.CompletableFuture<java.lang.Void>	unregisterScript(java.lang.String name) Let the vault owner unregister a script when the script become useless to applications.

Methods inherited from interface org.elastos.hive.service.ScriptingInvocationService

callScript, downloadFile, downloadFileByHiveUrl, uploadFile

Method Detail

registerScript

java.util.concurrent.CompletableFuture<java.lang.Void> registerScript(java.lang.String name,
                                                                      Executable executable)

registerScript

java.util.concurrent.CompletableFuture<java.lang.Void> registerScript(java.lang.String name,
                                                                      Condition condition,
                                                                      Executable executable)

registerScript

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

Lets the vault owner register a script on his vault for a given application. The script is built on the client-side, then serialized and stored on the vault service. Later on, the vault owner or external users can invoke the script to execute one of those scripts and get results or data.

Parameters:

name - the name of script to register

executable - the executable body of the script with preset routines

allowAnonymousUser - whether allows anonymous user.

allowAnonymousApp - whether allows anonymous application.

Returns:

Void

registerScript

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

Let the vault owner register a script on his vault for a given application.

Parameters:

name - the name of script to register

condition - the condition on which the script could be executed.

executable - the executable body of the script with preset routines

allowAnonymousUser - whether allows anonymous user.

allowAnonymousApp - whether allows anonymous application.

Returns:

Void

unregisterScript

java.util.concurrent.CompletableFuture<java.lang.Void> unregisterScript(java.lang.String name)

Let the vault owner unregister a script when the script become useless to applications.

Parameters:

name - the name of script to unregister.

Returns:

void