Package org.ametys.cms.scripts

Class CmsScriptBinding

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

org.ametys.cms.scripts.CmsScriptBinding

All Implemented Interfaces:

ScriptBinding, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

public class CmsScriptBinding
extends StaticConfigurableScriptBinding

CMS script binding, provides variables to the script tool, and a configuration file for the functions.

Field Summary

Fields inherited from class org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

_context, _functions, _functionsDescriptions, _pluginName, _sourceResolver, _tutorials, _variablesDescriptions, _variablesScripts, _workspacePattern

Constructor Summary

Constructors

Constructor	Description
CmsScriptBinding()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getVariables(ScriptExecArguments execArgs)	Returns the list of variables this ScriptBinding provides, mapped by variable name.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

_configureFunctions, _configureTutorials, _configureVariables, cleanVariables, configure, contextualize, getFunctions, getFunctionsDescriptions, getTutorials, getVariablesDescriptions, getVariablesScripts, getWorkspacePattern, setPluginInfo

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

Constructor Details

CmsScriptBinding

public CmsScriptBinding()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticConfigurableScriptBinding

Throws:

ServiceException

getVariables

public Map<String,Object> getVariables(ScriptExecArguments execArgs)

Description copied from interface: ScriptBinding

Returns the list of variables this ScriptBinding provides, mapped by variable name.

Specified by:

getVariables in interface ScriptBinding

Overrides:

getVariables in class StaticConfigurableScriptBinding

Parameters:

execArgs - The The arguments for script execution

Returns:

The list of variables, or null if no variable is provided.