org.elastos.hive.vault.scripting

Class ScriptingController

java.lang.Object

org.elastos.hive.vault.scripting.ScriptingController

public class ScriptingController
extends java.lang.Object

The wrapper class to access the scripting APIs of the hive node.

Constructor Summary

Constructors

Constructor and Description
ScriptingController(NodeRPCConnection connection) Create by the RPC connection.

Method Summary

Modifier and Type	Method and Description
<T> 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) Run the registered script.
<T> T	callScriptUrl(java.lang.String name, java.lang.String params, java.lang.String targetDid, java.lang.String targetAppDid, java.lang.Class<T> resultType) Call the script by the URL parameters.
<T> T	downloadFile(java.lang.String transactionId, java.lang.Class<T> resultType) Download file really by transaction ID.
void	registerScript(java.lang.String name, Condition condition, Executable executable, boolean allowAnonymousUser, boolean allowAnonymousApp) Register a script on the hive node.
void	unregisterScript(java.lang.String name) Unregister the script.
<T> T	uploadFile(java.lang.String transactionId, java.lang.Class<T> resultType) Upload file really by transaction ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptingController

public ScriptingController(NodeRPCConnection connection)

Create by the RPC connection.

Parameters:

connection - The RPC connection.

Method Detail

registerScript

public void registerScript(java.lang.String name,
                           Condition condition,
                           Executable executable,
                           boolean allowAnonymousUser,
                           boolean allowAnonymousApp)
                    throws HiveException

Register a script on the hive node.

Parameters:

name - The name of the script.

condition - The condition of the script. To run the script normally, the condition must be matched.

executable - The executable represents an executed action.

allowAnonymousUser - If allow the anonymous user to run the script.

allowAnonymousApp - If allow the anonymous application to run the script.

Throws:

HiveException - The error comes from the hive node.

callScript

public <T> 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)
                 throws HiveException

Run the registered script. The runner is not the owner of the script normally.

Type Parameters:

T - Same as result type.

Parameters:

name - The name of the script.

params - The parameters to run the script.

targetDid - The owner of the script.

targetAppDid - The application DID owns the script.

resultType - Supported type: String, byte[], JsonNode, Reader, other Json relating types.

Returns:

The instance of the result type.

Throws:

HiveException - See HiveException

callScriptUrl

public <T> T callScriptUrl(java.lang.String name,
                           java.lang.String params,
                           java.lang.String targetDid,
                           java.lang.String targetAppDid,
                           java.lang.Class<T> resultType)
                    throws HiveException

Call the script by the URL parameters. Same as callScript(String, JsonNode, String, String, Class).

Type Parameters:

T - Same as resultType.

Parameters:

name - The name of the script.

params - The parameters to run the script.

targetDid - The owner of the script.

targetAppDid - The application DID owns the script.

resultType - Supported type: String, byte[], JsonNode, Reader, other Json relating types.

Returns:

The instance of the result type.

Throws:

HiveException - See HiveException

uploadFile

public <T> T uploadFile(java.lang.String transactionId,
                        java.lang.Class<T> resultType)
                 throws HiveException

Upload file really by transaction ID.

Type Parameters:

T - The result type.

Parameters:

transactionId - The transaction ID got by calling script.

resultType - Supported type: OutputStream, OutputStreamWriter

Returns:

The instance of the result type.

Throws:

HiveException - See HiveException

downloadFile

public <T> T downloadFile(java.lang.String transactionId,
                          java.lang.Class<T> resultType)
                   throws HiveException

Download file really by transaction ID.

Type Parameters:

T - The result type.

Parameters:

transactionId - The transaction ID got by calling script.

resultType - Supported type: InputStream, InputStreamReader

Returns:

The instance of the result type.

Throws:

HiveException - See HiveException

unregisterScript

public void unregisterScript(java.lang.String name)
                      throws HiveException

Unregister the script.

Parameters:

name - The name of the script.

Throws:

HiveException - See HiveException