Package org.alfresco.repo.action.executer

Class ScriptActionExecuter

java.lang.Object

org.alfresco.repo.action.CommonResourceAbstractBase

org.alfresco.repo.action.ParameterizedItemAbstractBase

org.alfresco.repo.action.executer.ActionExecuterAbstractBase

org.alfresco.repo.action.executer.ScriptActionExecuter

All Implemented Interfaces:

ActionExecuter, LoggingAwareExecuter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

public class ScriptActionExecuter
extends ActionExecuterAbstractBase

Action to execute a JavaScript. The script has access to the default model. The actionedUponNodeRef is added to the default model as the 'document' and the owning NodeRef is added as the 'space'.

Author:

Kevin Roast

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME
static final String	PARAM_SCRIPTREF

Fields inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

actionAccessRestrictions, actionDefinition, applicableTypes, publicAction

Fields inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

adhocPropertiesAllowed, DISPLAY_LABEL, runtimeActionService

Fields inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

name

Fields inherited from interface org.alfresco.repo.action.executer.ActionExecuter

PARAM_RESULT

Constructor Summary

Constructors

Constructor	Description
ScriptActionExecuter()

Method Summary

Modifier and Type	Method	Description
protected void	addParameterDefinitions(List<ParameterDefinition> paramList)	Adds the parameter definitions to the list
protected void	executeImpl(Action action, NodeRef actionedUponNodeRef)	Execute the action implementation
protected boolean	getAdhocPropertiesAllowed()	Allow adhoc properties to be passed to this action
void	setCompanyHomePath(String companyHomePath)
void	setPersonService(PersonService personService)
void	setScriptLocation(ScriptLocation scriptLocation)	Set the script location from Spring
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setStoreUrl(String storeUrl)
void	setSysAdminParams(SysAdminParams sysAdminParams)

Methods inherited from class org.alfresco.repo.action.executer.ActionExecuterAbstractBase

createActionDefinition, execute, getActionAccessRestrictions, getActionDefinition, getIgnoreLock, getQueueName, getTrackStatus, init, isApplicableType, onLogException, setActionAccessRestrictions, setApplicableTypes, setBaseNodeService, setDictionaryService, setIgnoreLock, setLockService, setMlAwareNodeService, setPublicAction, setQueueName, setTrackStatus, verifyActionAccessRestrictions

Methods inherited from class org.alfresco.repo.action.ParameterizedItemAbstractBase

checkMandatoryProperties, getDescriptionKey, getLocalizedParameterDefinitions, getParamDisplayLabel, getParamDisplayLabel, getParameterDefintions, getTitleKey, setAdhocPropertiesAllowed, setLocales, setRuntimeActionService, toString

Methods inherited from class org.alfresco.repo.action.CommonResourceAbstractBase

setBeanName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.alfresco.repo.action.executer.ActionExecuter

isExecuteAsynchronously

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PARAM_SCRIPTREF

public static final String PARAM_SCRIPTREF

See Also:

• Constant Field Values

Constructor Details

ScriptActionExecuter

public ScriptActionExecuter()

Method Details

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

Parameters:

serviceRegistry - The serviceRegistry to set.

setSysAdminParams

public void setSysAdminParams(SysAdminParams sysAdminParams)

Parameters:

sysAdminParams - The sysAdminParams to set.

setPersonService

public void setPersonService(PersonService personService)

Parameters:

personService - The personService to set.

setStoreUrl

public void setStoreUrl(String storeUrl)

setCompanyHomePath

public void setCompanyHomePath(String companyHomePath)

setScriptLocation

public void setScriptLocation(ScriptLocation scriptLocation)

Set the script location from Spring

Parameters:

scriptLocation - the script location

getAdhocPropertiesAllowed

protected boolean getAdhocPropertiesAllowed()

Allow adhoc properties to be passed to this action

Overrides:

getAdhocPropertiesAllowed in class ParameterizedItemAbstractBase

Returns:

true if they are, by default false

See Also:

• ParameterizedItemAbstractBase.getAdhocPropertiesAllowed()

executeImpl

protected void executeImpl(Action action,
 NodeRef actionedUponNodeRef)

Description copied from class: ActionExecuterAbstractBase

Execute the action implementation

Specified by:

executeImpl in class ActionExecuterAbstractBase

Parameters:

action - the action

actionedUponNodeRef - the actioned upon node

See Also:

• ActionExecuterAbstractBase.executeImpl(org.alfresco.service.cmr.action.Action, org.alfresco.service.cmr.repository.NodeRef)

addParameterDefinitions

protected void addParameterDefinitions(List<ParameterDefinition> paramList)

Description copied from class: ParameterizedItemAbstractBase

Adds the parameter definitions to the list

Specified by:

addParameterDefinitions in class ParameterizedItemAbstractBase

Parameters:

paramList - the parameter definitions list

See Also:

• ParameterizedItemAbstractBase.addParameterDefinitions(java.util.List)