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

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 and Description
protected org.alfresco.service.cmr.action.ActionService	actionService
protected org.alfresco.service.cmr.action.ActionTrackingService	actionTrackingService
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected org.alfresco.repo.action.RuntimeActionService	runtimeActionService

Constructor Summary

Constructors

Constructor and Description
AbstractActionWebscript()

Method Summary

Methods

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

actionService

protected org.alfresco.service.cmr.action.ActionService actionService

runtimeActionService

protected org.alfresco.repo.action.RuntimeActionService runtimeActionService

actionTrackingService

protected org.alfresco.service.cmr.action.ActionTrackingService actionTrackingService

Constructor Detail

AbstractActionWebscript

public AbstractActionWebscript()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setActionService

public void setActionService(org.alfresco.service.cmr.action.ActionService actionService)

setRuntimeActionService

public void setRuntimeActionService(org.alfresco.repo.action.RuntimeActionService runtimeActionService)

setActionTrackingService

public void setActionTrackingService(org.alfresco.service.cmr.action.ActionTrackingService actionTrackingService)

executeImpl

protected java.util.Map 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 java.util.Map buildModel(RunningActionModelBuilder modelBuilder,
                       org.springframework.extensions.webscripts.WebScriptRequest req,
                       org.springframework.extensions.webscripts.Status status,
                       org.springframework.extensions.webscripts.Cache cache)

getSummaryFromKey

public static org.alfresco.service.cmr.action.ExecutionSummary getSummaryFromKey(java.lang.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 org.alfresco.service.cmr.action.ExecutionSummary getSummaryFromAction(org.alfresco.service.cmr.action.Action action)

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

getRunningId

public static java.lang.String getRunningId(org.alfresco.service.cmr.action.ExecutionSummary summary)

Returns the running action ID for the given ExecutionSummary