de.hybris.platform.processengine.process

Class ProcessengineTaskRunner

java.lang.Object

de.hybris.platform.processengine.process.ProcessengineTaskRunner

All Implemented Interfaces:

TaskRunner<ProcessTaskModel>

public class ProcessengineTaskRunner
extends Object
implements TaskRunner<ProcessTaskModel>

Special TaskRunner implementation intended to work with ProcessengineTaskExecutionStrategy only! This runner takes over responsibility to start and finish transaction contrary to DefaultTaskExecutionStrategy.

Constructor Summary

Constructors

Constructor and Description
ProcessengineTaskRunner()

Method Summary

Modifier and Type	Method and Description
protected void	beforeRun(TaskService taskService, ProcessTaskModel task)
protected String	closeLogAndReadMessages(FileAppender appender)
protected String	doRun(TaskService taskService, ProcessTaskModel task) Executes runProcessTask(ProcessTaskModel) via runProcessTaskInTransaction(ProcessTaskModel) and performs error handling via processRunError(TaskService, ProcessTaskModel, Throwable).
protected void	finishLogging(BusinessProcessModel process, ProcessTaskModel task, FileAppender appender, Date startDate, String returnCode) Deprecated.
protected Node	getNodeForExecution(ProcessTaskModel task) Fetches node for execution.
protected ProcessDefinition	getProcessDefinition(BusinessProcessModel process)
void	handleError(TaskService taskManager, ProcessTaskModel task, Throwable error)
ProcessEngineLoggingCtx	initLoggingCtx(ProcessTaskModel task)
protected String	processRunError(TaskService taskService, ProcessTaskModel task, Throwable e) Processes error that has occurred either during node execution or transaction handling around it.
void	run(TaskService taskService, ProcessTaskModel task) Captures logs and performs actual business logic via doRun(TaskService, ProcessTaskModel).
protected String	runProcessTask(ProcessTaskModel task) Performs actual processing of node business logic.
protected String	runProcessTaskInTransaction(ProcessTaskModel task) Wraps runProcessTask(ProcessTaskModel) into transaction.
void	setModelService(ModelService modelService)
void	setProcessDefinitionFactory(ProcessDefinitionFactory processDefinitionFactory)
void	setProcessParameterHelper(ProcessParameterHelper processParameterHelper)
void	setSessionService(SessionService sessionService)
void	setTransactionTemplate(TransactionTemplate transactionTemplate)
void	setUserService(UserService userService)
protected FileAppender	startLogging(BusinessProcessModel process, ProcessTaskModel task) Deprecated.
void	stopLoggingCtx(TaskLoggingCtx taskCtx)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.task.TaskRunner

isLoggingSupported

Constructor Detail

ProcessengineTaskRunner

public ProcessengineTaskRunner()

Method Detail

run

public void run(TaskService taskService,
                ProcessTaskModel task)
         throws RetryLaterException

Captures logs and performs actual business logic via doRun(TaskService, ProcessTaskModel).

Specified by:

run in interface TaskRunner<ProcessTaskModel>

Throws:

RetryLaterException

See Also:

ProcessEngineLoggingCtx, doRun(TaskService, ProcessTaskModel)

doRun

protected String doRun(TaskService taskService,
                       ProcessTaskModel task)
                throws RetryLaterException

Executes runProcessTask(ProcessTaskModel) via runProcessTaskInTransaction(ProcessTaskModel) and performs error handling via processRunError(TaskService, ProcessTaskModel, Throwable).

Throws:

RetryLaterException

See Also:

runProcessTaskInTransaction(ProcessTaskModel), processRunError(TaskService, ProcessTaskModel, Throwable)

runProcessTaskInTransaction

protected String runProcessTaskInTransaction(ProcessTaskModel task)
                                      throws RetryLaterException,
                                             NodeExecutionException

Wraps runProcessTask(ProcessTaskModel) into transaction.

Throws:

RetryLaterException

NodeExecutionException

See Also:

runProcessTask(ProcessTaskModel)

runProcessTask

protected String runProcessTask(ProcessTaskModel task)
                         throws RetryLaterException,
                                NodeExecutionException

Performs actual processing of node business logic. Intended to be called inside a transaction.

Throws:

RetryLaterException

NodeExecutionException

getNodeForExecution

protected Node getNodeForExecution(ProcessTaskModel task)

Fetches node for execution.

processRunError

protected String processRunError(TaskService taskService,
                                 ProcessTaskModel task,
                                 Throwable e)

Processes error that has occurred either during node execution or transaction handling around it. Generally switches the process into error state and delegates to optionally existing error node from process definition.

beforeRun

protected void beforeRun(TaskService taskService,
                         ProcessTaskModel task)

handleError

public void handleError(TaskService taskManager,
                        ProcessTaskModel task,
                        Throwable error)

Specified by:

handleError in interface TaskRunner<ProcessTaskModel>

getProcessDefinition

protected ProcessDefinition getProcessDefinition(BusinessProcessModel process)

startLogging

@Deprecated
protected FileAppender startLogging(BusinessProcessModel process,
                                                ProcessTaskModel task)

Deprecated.

Not used anymore. ProcessEngineLoggingCtx is responsible for logging.

Parameters:

process -

task -

Returns:

finishLogging

@Deprecated
protected void finishLogging(BusinessProcessModel process,
                                         ProcessTaskModel task,
                                         FileAppender appender,
                                         Date startDate,
                                         String returnCode)

Deprecated.

Not used anymore. ProcessEngineLoggingCtx is responsible for logging.

Parameters:

process -

task -

appender -

startDate -

returnCode -

closeLogAndReadMessages

protected String closeLogAndReadMessages(FileAppender appender)

setTransactionTemplate

public void setTransactionTemplate(TransactionTemplate transactionTemplate)

setProcessDefinitionFactory

public void setProcessDefinitionFactory(ProcessDefinitionFactory processDefinitionFactory)

setProcessParameterHelper

public void setProcessParameterHelper(ProcessParameterHelper processParameterHelper)

setModelService

public void setModelService(ModelService modelService)

setUserService

public void setUserService(UserService userService)

setSessionService

public void setSessionService(SessionService sessionService)

initLoggingCtx

public ProcessEngineLoggingCtx initLoggingCtx(ProcessTaskModel task)

Specified by:

initLoggingCtx in interface TaskRunner<ProcessTaskModel>

stopLoggingCtx

public void stopLoggingCtx(TaskLoggingCtx taskCtx)

Specified by:

stopLoggingCtx in interface TaskRunner<ProcessTaskModel>