Package org.cyclos.impl.system

Interface CustomScriptServiceLocal

All Superinterfaces:

CRUDService<CustomScriptDTO,CustomScriptData,ScriptType>, CRUDServiceLocal<CustomScript,CustomScriptDTO,CustomScriptData,ScriptType>, CustomScriptService, Service

public interface CustomScriptServiceLocal
extends CRUDServiceLocal<CustomScript,CustomScriptDTO,CustomScriptData,ScriptType>, CustomScriptService

Local interface for CustomScriptServiceLocal

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_ENTITY_MANAGER	Script context binding: the JPA EntityManager instance
static String	ATTR_FORMATTER	Script context binding: the FormatterImpl instance
static String	ATTR_SCRIPT_HELPER	Script context binding: the ScriptHelper instance
static String	ATTR_SCRIPT_PARAMETERS	Script context binding: script parameters, as Properties
static String	ATTR_SESSION_DATA	Script context binding: the SessionData instance
static String	ATTR_TRANSACTION_LEVEL	Script context binding: the TransactionLevel instance
static String	ATTR_TRANSACTION_STATUS	Script context binding: the TransactionStatus instance

Method Summary

Modifier and Type	Method	Description
ScriptFunction[]	getFunctions(ScriptType type)	Returns the script function instances for the given type
Set<Long>	getReverseDependencyIds(Long id)	Returns the identifiers of all scripts which depend, directly or indirectly on the script with the given id.
List<CustomScript>	listByType(ScriptType type)	Returns a list of scripts by type
CustomScriptAccessor	newAccessor(CustomScript script, String scriptParameters)	Returns a CustomScriptAccessor which can be used to run the given script.
Bindings	resolveBindings(String parameters, Map<String,Object> additionalBindings)	Returns all bindings which are common to all scripts, plus the given script parameters and additional bindings
Pair<String,String>	resolveCodeAndParameters(CustomScript script, ScriptFunction function)	Returns the final code for the given script function, together with the final parameters, concatenated from all dependencies.
String	resolveCodeForProfiling(String scriptName, String scriptType, String functionName)	Returns the final code for the given script function concatenated from all dependencies.
<T> T	runScript(String code, String parameters, Map<String,Object> bindings, Set<CustomScript> libraries, boolean allPermissions)	Runs the given script code directly, with parameters.
<T> T	runScript(String code, Set<CustomScript> libraries)	Runs the given script code directly.

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomScriptService

getCodeForDebug, getRunData, listUsages, run, search

Field Detail

ATTR_SCRIPT_PARAMETERS

static final String ATTR_SCRIPT_PARAMETERS

Script context binding: script parameters, as Properties

See Also:

Constant Field Values

ATTR_SCRIPT_HELPER

static final String ATTR_SCRIPT_HELPER

Script context binding: the ScriptHelper instance

See Also:

Constant Field Values

ATTR_SESSION_DATA

static final String ATTR_SESSION_DATA

Script context binding: the SessionData instance

See Also:

Constant Field Values

ATTR_TRANSACTION_STATUS

static final String ATTR_TRANSACTION_STATUS

Script context binding: the TransactionStatus instance

See Also:

Constant Field Values

ATTR_TRANSACTION_LEVEL

static final String ATTR_TRANSACTION_LEVEL

Script context binding: the TransactionLevel instance

See Also:

Constant Field Values

ATTR_ENTITY_MANAGER

static final String ATTR_ENTITY_MANAGER

Script context binding: the JPA EntityManager instance

See Also:

Constant Field Values

ATTR_FORMATTER

static final String ATTR_FORMATTER

Script context binding: the FormatterImpl instance

See Also:

Constant Field Values

Method Detail

getFunctions

ScriptFunction[] getFunctions(ScriptType type)

Returns the script function instances for the given type

getReverseDependencyIds

Set<Long> getReverseDependencyIds(Long id)

Returns the identifiers of all scripts which depend, directly or indirectly on the script with the given id. The purpose of exposing this method in the interface is to test it

listByType

List<CustomScript> listByType(ScriptType type)

Returns a list of scripts by type

newAccessor

CustomScriptAccessor newAccessor(CustomScript script,
                                 String scriptParameters)

Returns a CustomScriptAccessor which can be used to run the given script.

resolveBindings

Bindings resolveBindings(String parameters,
                         Map<String,Object> additionalBindings)

Returns all bindings which are common to all scripts, plus the given script parameters and additional bindings

resolveCodeAndParameters

Pair<String,String> resolveCodeAndParameters(CustomScript script,
                                                   ScriptFunction function)

Returns the final code for the given script function, together with the final parameters, concatenated from all dependencies. The purpose of exposing this method in the interface is to test it

resolveCodeForProfiling

String resolveCodeForProfiling(String scriptName,
                               String scriptType,
                               String functionName)

Returns the final code for the given script function concatenated from all dependencies. The parameters (which can contain sensitive information like API keys, credentials, etc.) are not included because the resulting code will be stored in a profiling session.

runScript

<T> T runScript(String code,
                Set<CustomScript> libraries)

Runs the given script code directly. Will run as system, with all default bindings available

runScript

<T> T runScript(String code,
                String parameters,
                Map<String,Object> bindings,
                Set<CustomScript> libraries,
                boolean allPermissions)

Runs the given script code directly, with parameters. Will run as system, with all default bindings available