Package org.ametys.plugins.core.ui.script

Class ScriptHandler

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.script.ScriptHandler

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

Direct Known Subclasses:

AsyncScriptHandler, CmsScriptHandler, RepositoryScriptHandler, ScriptVersionHandlerScriptHandler

public class ScriptHandler
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable

Handler to describe and execute server scripts

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ScriptHandler.ResultProcessor	A processor for scripts results.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_context	The avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	The i18n utils
protected RightManager	_rightManager	The right manager
protected ScriptBindingExtensionPoint	_scriptBindingEP	The script binding extension point
protected static final String	RIGHT_EXECUTE_SCRIPTS	Right for script execution
static final String	ROLE	Avalon role.

Constructor Summary

Constructors

Constructor	Description
ScriptHandler()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_executeScript(ScriptExecArguments arguments, Map<String,Object> scriptVariables, String workspaceName)	Execute a script in the js admin console.
protected ScriptExecArguments	buildExecArguments(Map<String,Object> arguments)	Builds the ScriptExecArguments object from the untyped JS object (seen as a Map in Java)
void	contextualize(Context context)
final Map<String,Object>	executeScript(String script)	Execute a script in the js admin console.
Map<String,Object>	executeScript(String script, Map<String,Object> scriptVariables, String workspaceName)	Execute a script in the js console.
Map<String,Object>	executeScript(Map<String,Object> arguments)	Execute a script in the js console.
protected ScriptHandler.ResultProcessor	getProcessor()	Returns the ScriptHandler.ResultProcessor used to process script result.
List<Map<String,Object>>	getScriptBindingDescription()	Get the list of variables and functions descriptions currently registered for the Scripts.
protected String	getWorkspaceName()	Gets the workspace name
protected Object	processScriptResult(Map<String,Object> results, Object scriptResult, ScriptExecArguments execArgs)	Process the result of the script
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon role.

RIGHT_EXECUTE_SCRIPTS

protected static final String RIGHT_EXECUTE_SCRIPTS

Right for script execution

See Also:

• Constant Field Values

_scriptBindingEP

protected ScriptBindingExtensionPoint _scriptBindingEP

The script binding extension point

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_context

protected Context _context

The avalon context

Constructor Details

ScriptHandler

public ScriptHandler()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

buildExecArguments

protected ScriptExecArguments buildExecArguments(Map<String,Object> arguments)

Builds the ScriptExecArguments object from the untyped JS object (seen as a Map in Java)

Parameters:

arguments - The untyped JS object

Returns:

the ScriptExecArguments

executeScript

public final Map<String,Object> executeScript(String script)
                                       throws ScriptException

Execute a script in the js admin console.

Parameters:

script - The script as a String.

Returns:

A map of information on the script execution.

Throws:

ScriptException - If an error occurs

executeScript

public Map<String,Object> executeScript(Map<String,Object> arguments)
                                 throws ScriptException

Execute a script in the js console.

Parameters:

arguments - The map of arguments. Must contains at least the argument "script"

Returns:

A map of information on the script execution.

Throws:

ScriptException - If an error occurs

executeScript

public Map<String,Object> executeScript(String script,
 Map<String,Object> scriptVariables,
 String workspaceName)
                                 throws ScriptException

Execute a script in the js console.

Parameters:

script - The script as a String.

scriptVariables - map of variables that will be added to the script.

workspaceName - The workspace name

Returns:

A map of information on the script execution.

Throws:

ScriptException - If an error occurs

_executeScript

protected Map<String,Object> _executeScript(ScriptExecArguments arguments,
 Map<String,Object> scriptVariables,
 String workspaceName)
                                     throws ScriptException

Execute a script in the js admin console.

Parameters:

arguments - The arguments for script execution

scriptVariables - map of variables that will be added to the script.

workspaceName - The workspace name

Returns:

A map of information on the script execution.

Throws:

ScriptException - If an error occurs

processScriptResult

protected Object processScriptResult(Map<String,Object> results,
 Object scriptResult,
 ScriptExecArguments execArgs)

Process the result of the script

Parameters:

results - The results map, available to fill

scriptResult - The result of the script

execArgs - The script execution arguments

Returns:

The processed result

getProcessor

protected ScriptHandler.ResultProcessor getProcessor()

Returns the ScriptHandler.ResultProcessor used to process script result.

Returns:

the ScriptHandler.ResultProcessor.

getScriptBindingDescription

public List<Map<String,Object>> getScriptBindingDescription()

Get the list of variables and functions descriptions currently registered for the Scripts.

Returns:

The list of variables and functions, as describes by the script bindings available.

getWorkspaceName

protected String getWorkspaceName()

Gets the workspace name

Returns:

the workspace name