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, Serviceable

public class ScriptHandler
extends AbstractLogEnabled
implements Component, Serviceable

Handler to describe and execute server scripts

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__RIGHT_EXECUTE_SCRIPTS
private static String	__SCRIPT_INSERT_CLEANUP_MANAGER
private static String	__SCRIPT_INSERT_RUN_MAIN
private CurrentUserProvider	_currentUserProvider
private RightManager	_rightManager
private ScriptBindingExtensionPoint	_scriptBindingEP

Constructor Summary

Constructors

Constructor and Description
ScriptHandler()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	executeScript(String script) Execute a script in the js admin console.
Map<String,Object>	getScriptBindingDescription() Get the list of variables and functions descriptions currently registered for the Scripts.
private Object	processScriptResult(Object result)
void	service(ServiceManager serviceManager)
private void	setScriptBindings(Map<String,Object> variables, List<String> scriptText)

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 Detail

__RIGHT_EXECUTE_SCRIPTS

private static final String __RIGHT_EXECUTE_SCRIPTS

See Also:

Constant Field Values

__SCRIPT_INSERT_CLEANUP_MANAGER

private static final String __SCRIPT_INSERT_CLEANUP_MANAGER

See Also:

Constant Field Values

__SCRIPT_INSERT_RUN_MAIN

private static final String __SCRIPT_INSERT_RUN_MAIN

See Also:

Constant Field Values

_scriptBindingEP

private ScriptBindingExtensionPoint _scriptBindingEP

_rightManager

private RightManager _rightManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

Constructor Detail

ScriptHandler

public ScriptHandler()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

executeScript

public 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

setScriptBindings

private void setScriptBindings(Map<String,Object> variables,
                               List<String> scriptText)

processScriptResult

private Object processScriptResult(Object result)
                            throws ScriptException

Throws:

ScriptException

getScriptBindingDescription

public 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.