Interface ScriptingManager

public interface ScriptingManager

ScriptingManager. Defines the operations that can be performed on scripts. Scripts are stored in a dedicated cache.

Since:

7.2

Author:

Tristan Tarrant

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCRIPT_CACHE	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	SCRIPT_MANAGER_ROLE	Deprecated, for removal: This API element is subject to removal in a future version. since 12.1.

Method Summary

Modifier and Type	Method	Description
void	addScript(String name, String script)	Adds a new named script.
void	addScript(String name, String script, org.infinispan.scripting.impl.ScriptMetadata metadata)	Adds a new named script with user-specified metadata
boolean	containsScript(String scriptName)	Returns whether a script exists
String	getScript(String scriptName)	Retrieves the source code of an existing script.
Set<String>	getScriptNames()	Retrieves names of all available scripts.
org.infinispan.scripting.impl.ScriptWithMetadata	getScriptWithMetadata(String scriptName)	Retrieves the source code of an existing script together with its metadata
void	removeScript(String name)	Removes a script.
<T> CompletionStage<T>	runScript(String scriptName)	Runs a named script
<T> CompletionStage<T>	runScript(String scriptName, TaskContext context)	Runs a named script using the specified TaskContext

Field Details

SCRIPT_CACHE

@Deprecated(forRemoval=true,
            since="15.0")
static final String SCRIPT_CACHE

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

SCRIPT_MANAGER_ROLE

@Deprecated(forRemoval=true,
            since="12.1")
static final String SCRIPT_MANAGER_ROLE

Deprecated, for removal: This API element is subject to removal in a future version.

since 12.1. Will be removed in 15.0. Use the CREATE permission instead.

See Also:

• Constant Field Values

Method Details

addScript

void addScript(String name,
 String script)

Adds a new named script.

Parameters:

name - the name of the script. The name should contain an extension identifying its language

script - the source of the script

addScript

void addScript(String name,
 String script,
 org.infinispan.scripting.impl.ScriptMetadata metadata)

Adds a new named script with user-specified metadata

Parameters:

name - the name of the script. The name should contain an extension identifying its language

script - the source of the script

metadata - the metadata for the script

removeScript

void removeScript(String name)

Removes a script.

Parameters:

name - the name of the script ro remove

runScript

<T> CompletionStage<T> runScript(String scriptName)

Runs a named script

Parameters:

scriptName - The name of the script to run. Use addScript(String, String) to add a script

Returns:

a CompletableFuture which will return the result of the script execution

runScript

<T> CompletionStage<T> runScript(String scriptName,
 TaskContext context)

Runs a named script using the specified TaskContext

Parameters:

scriptName - The name of the script to run. Use addScript(String, String) to add a script

context - A TaskContext within which the script will be executed

Returns:

a CompletableFuture which will return the result of the script execution

getScript

String getScript(String scriptName)

Retrieves the source code of an existing script.

Parameters:

scriptName - The name of the script

Returns:

the source code of the script

getScriptWithMetadata

org.infinispan.scripting.impl.ScriptWithMetadata getScriptWithMetadata(String scriptName)

Retrieves the source code of an existing script together with its metadata

Parameters:

scriptName - The name of the script

Returns:

the source code of the script

getScriptNames

Set<String> getScriptNames()

Retrieves names of all available scripts.

Returns:

Set<String> containing names of available scripts.

containsScript

boolean containsScript(String scriptName)

Returns whether a script exists

Parameters:

scriptName - the name of the script

Returns:

a boolean indicating script existence