Package org.alfresco.repo.web.scripts.action

Class AbstractActionWebscript

java.lang.Object

org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.DeclarativeWebScript

org.alfresco.repo.web.scripts.action.AbstractActionWebscript

All Implemented Interfaces:

org.springframework.extensions.webscripts.WebScript

Direct Known Subclasses:

AbstractExecuteActionWebscript, RunningActionDelete, RunningActionGet, RunningActionsGet, RunningReplicationActionsGet

public abstract class AbstractActionWebscript
extends org.springframework.extensions.webscripts.DeclarativeWebScript

Since:

3.4

Author:

Nick Burch

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript

org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionService	actionService
protected ActionTrackingService	actionTrackingService
protected NodeService	nodeService
protected RuntimeActionService	runtimeActionService

Constructor Summary

Constructors

Constructor	Description
AbstractActionWebscript()

Method Summary

Modifier and Type	Method	Description
protected abstract Map<String,Object>	buildModel(RunningActionModelBuilder modelBuilder, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
protected Map<String,Object>	executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache)
static String	getRunningId(ExecutionSummary summary)	Returns the running action ID for the given ExecutionSummary
static ExecutionSummary	getSummaryFromAction(Action action)	Returns the ExecutionSummary for the given action if it is currently executing, or null if it isn't
static ExecutionSummary	getSummaryFromKey(String key)	Takes a running action ID, and returns an ExecutionSummary object for it.
void	setActionService(ActionService actionService)
void	setActionTrackingService(ActionTrackingService actionTrackingService)
void	setNodeService(NodeService nodeService)
void	setRuntimeActionService(RuntimeActionService runtimeActionService)

Methods inherited from class org.springframework.extensions.webscripts.DeclarativeWebScript

execute, executeFinallyImpl, executeImpl, executeImpl, getTemplateModel, renderFormatTemplate

Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript

addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString

Methods inherited from class java.lang.Object

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

Field Detail

nodeService

protected NodeService nodeService

actionService

protected ActionService actionService

runtimeActionService

protected RuntimeActionService runtimeActionService

actionTrackingService

protected ActionTrackingService actionTrackingService

Constructor Detail

AbstractActionWebscript

public AbstractActionWebscript()

Method Detail

setNodeService

public void setNodeService(NodeService nodeService)

setActionService

public void setActionService(ActionService actionService)

setRuntimeActionService

public void setRuntimeActionService(RuntimeActionService runtimeActionService)

setActionTrackingService

public void setActionTrackingService(ActionTrackingService actionTrackingService)

executeImpl

protected Map<String,Object> executeImpl(org.springframework.extensions.webscripts.WebScriptRequest req,
                                               org.springframework.extensions.webscripts.Status status,
                                               org.springframework.extensions.webscripts.Cache cache)

Overrides:

executeImpl in class org.springframework.extensions.webscripts.DeclarativeWebScript

buildModel

protected abstract Map<String,Object> buildModel(RunningActionModelBuilder modelBuilder,
                                                       org.springframework.extensions.webscripts.WebScriptRequest req,
                                                       org.springframework.extensions.webscripts.Status status,
                                                       org.springframework.extensions.webscripts.Cache cache)

getSummaryFromKey

public static ExecutionSummary getSummaryFromKey(String key)

Takes a running action ID, and returns an ExecutionSummary object for it. Note - doesn't check to see if the object exists in the cache though!

getSummaryFromAction

public static ExecutionSummary getSummaryFromAction(Action action)

Returns the ExecutionSummary for the given action if it is currently executing, or null if it isn't

getRunningId

public static String getRunningId(ExecutionSummary summary)

Returns the running action ID for the given ExecutionSummary