org.egov.infra.script.service

Class ScriptService

java.lang.Object

org.egov.infra.script.service.ScriptService

@Transactional(readOnly=true)
 @Service
public class ScriptService
extends Object

Service for executing scripts. Caches the script engine and frequently used scripts to improve performance. Also provides methods that can be used from within scripts to invoke other scripts or functions from already loaded scripts.

Code snippet:

 scriptService.executeScript("script name", ScriptService.createContext("var1",
                value1, "var2", value2));
 
 

Constructor Summary

Constructors

Constructor and Description
ScriptService()

Method Summary

Modifier and Type	Method and Description
void	clearScriptCache() Clears the script cache
static ScriptContext	createContext(Object... args) Takes an even number of arguments, and creates a ScriptContext object, with ith argument as the key and (i+1)th argument as the value.
Object	executeFunction(ScriptEngine engine, String functionName, Object... args) Executes given function using given script engine
Object	executeFunctionNoArgs(ScriptEngine engine, String functionName) Executes given function using given script engine
Object	executeScript(Script script, ScriptContext context) Executes the given script with context as the ScriptContext.
Object	executeScript(String scriptName, ScriptContext context) Executes the given script with context as the ScriptContext.
Object	executeScript(String scriptName, ScriptContext context, Date asOnDate) Executes the given script with context as the ScriptContext as on given date.
Script	findByNameAndPeriod(String name, Date period)
Script	getByName(String name)
void	loadFunctionsFromScript(String scriptName) Loads all functions from given script.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptService

public ScriptService()

Method Detail

getByName

public Script getByName(String name)

findByNameAndPeriod

public Script findByNameAndPeriod(String name,
                                  Date period)

createContext

public static ScriptContext createContext(Object... args)

Takes an even number of arguments, and creates a ScriptContext object, with ith argument as the key and (i+1)th argument as the value. This is why this method expects an even number of arguments.

Parameters:

args - Arguments from which the context will be created

Returns:

The script context in which a script can be executed. This can be passed as second argument to the method executeScript(String, ScriptContext)

loadFunctionsFromScript

public void loadFunctionsFromScript(String scriptName)

Loads all functions from given script.

Parameters:

scriptName - Script which is to be loaded

executeFunctionNoArgs

public Object executeFunctionNoArgs(ScriptEngine engine,
                                    String functionName)

Executes given function using given script engine

Parameters:

engine - Script engine to be used for executing the function

functionName - Name of function to be executed

Returns:

Return value from the function

executeFunction

public Object executeFunction(ScriptEngine engine,
                              String functionName,
                              Object... args)

Executes given function using given script engine

Parameters:

engine - Script engine to be used for executing the function

functionName - Name of function to be executed

args - Arguments to be passed to the function

Returns:

Return value from the function

executeScript

public Object executeScript(Script script,
                            ScriptContext context)

Executes the given script with context as the ScriptContext. The values in the context are available as variables in the script. The names of these variables will be the attributes in the context.

Parameters:

script - Script to be executed

context - The script context - attributes in this context can be used as variables inside the script

Returns:

The result from the script, or the value of the script variable "result"

Throws:

ValidationException - if the script returns a list of ValidationErrors

executeScript

public Object executeScript(String scriptName,
                            ScriptContext context)

Executes the given script with context as the ScriptContext. The values in the context are available as variables in the script. The names of these variables will be the attributes in the context

Parameters:

scriptName - Name of script to be executed

context -

Returns:

The result from the script, or the value of the script variable "result"

Throws:

ValidationException - , if the script returns a list of ValidationErrors

executeScript

public Object executeScript(String scriptName,
                            ScriptContext context,
                            Date asOnDate)

Executes the given script with context as the ScriptContext as on given date. This means that the script that was valid as on given date will be executed (not the currently valid one). The values in the context are available as variables in the script. The names of these variables will be the attributes in the context.

Parameters:

scriptName - Name of script to be executed

context -

asOnDate - The date as on which the script is to be executed

Returns:

The result from the script, or the value of the script variable "result"

Throws:

ValidationException - , if the script returns a list of ValidationErrors

clearScriptCache

public void clearScriptCache()

Clears the script cache