com.broadleafcommerce.jobsevents.service

Interface ProcessManager

All Known Implementing Classes:

ProcessManagerImpl

public interface ProcessManager

API for managing ProcessStatus state. Each jobs and events node manages its own list of ProcessStatus instances for async processes it is currently working on.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
void	dropProcess() Remove the process from the list of currently active processes on this server.
void	endProcess() Finish a process when the async thread of execution is complete.
Map<Long,ProcessStatus>	getProcesses() Return the list of currently active processes on this server.
void	pauseProcess() Remove the process from the list of currently active processes on this server and set the state to true for isPaused in the database.
void	setExecution(Long executionId, String executionType) Set the information that associates a specific async thread of execution with a ProcessStatus instance.
void	setProgress(long count, long total) Set ProcessStatus.getPercentComplete()
void	startProcess(String name, String friendlyName, String description) Add a new arbitrary ProcessStatus to the list of currently active processes on this server.
void	startProcess(String name, String friendlyName, String description, Boolean isPaused) Add a new arbitrary ProcessStatus to the list of currently active processes on this server.
void	startProcess(String name, String friendlyName, String description, String executionType, Long executionId) Add a new arbitrary ProcessStatus to the list of currently active processes on this server.
void	startProcess(String name, String friendlyName, String description, String executionType, Long executionId, Boolean isPaused) Add a new arbitrary ProcessStatus to the list of currently active processes on this server.
void	startProcess(SystemEvent event) Add a new ProcessStatus to the list of currently active processes on this server.
boolean	supportsResume(Long processId) Detects if a ProcessStatus can be resumed.
void	unPauseProcess(Long processId) Sets the isPaused state to false for the ProcessStatus.

Method Detail

startProcess

void startProcess(SystemEvent event)

Add a new ProcessStatus to the list of currently active processes on this server. This is generally called from DatabaseSystemEventNodeImpl when consuming an event.

Parameters:

event -

startProcess

void startProcess(String name,
                  String friendlyName,
                  String description)

Add a new arbitrary ProcessStatus to the list of currently active processes on this server.

Parameters:

name -

friendlyName -

description -

startProcess

void startProcess(String name,
                  String friendlyName,
                  String description,
                  Boolean isPaused)

Add a new arbitrary ProcessStatus to the list of currently active processes on this server.

Parameters:

name -

friendlyName -

description -

isPaused -

startProcess

void startProcess(String name,
                  String friendlyName,
                  String description,
                  String executionType,
                  Long executionId)

Add a new arbitrary ProcessStatus to the list of currently active processes on this server.

Parameters:

name -

friendlyName -

description -

executionType -

executionId -

startProcess

void startProcess(String name,
                  String friendlyName,
                  String description,
                  String executionType,
                  Long executionId,
                  Boolean isPaused)

Add a new arbitrary ProcessStatus to the list of currently active processes on this server.

Parameters:

name -

friendlyName -

description -

executionType -

executionId -

isPaused -

endProcess

void endProcess()

Finish a process when the async thread of execution is complete. At this point the ProcessStatus is removed from the list of currently active processes and archived in the database.

pauseProcess

void pauseProcess()

Remove the process from the list of currently active processes on this server and set the state to true for isPaused in the database. The ProcessStatus.getLastUpdated() is no longer updated. Note, this does nothing to actually stop the async thread of execution. Paused processes are not eligible for abandoned process handling until the unPauseProcess(Long) method is called.

dropProcess

void dropProcess()

Remove the process from the list of currently active processes on this server. The ProcessStatus.getLastUpdated() is no longer updated. Note, this does nothing to actually stop the async thread of execution. Dropped processes are eligible for abandoned process handling after their age threshold expiration.

getProcesses

Map<Long,ProcessStatus> getProcesses()

Return the list of currently active processes on this server. Keyed by ProcessStatus.getProcessId().

Returns:

unPauseProcess

void unPauseProcess(Long processId)

Sets the isPaused state to false for the ProcessStatus. This has the effect of making this ProcessStatus eligible for abandoned process handling. Presumably the HandleAbandonedProcessEvent listener for this ProcessStatus.getExecutionType() will cause the resumption of execution.

Parameters:

processId -

supportsResume

boolean supportsResume(Long processId)

Detects if a ProcessStatus can be resumed. This information can be used to drive whether or not a ProcessStatus instance should be allowed to pause. The standard way to inform the system that a ProcessStatus supports resume is to make a listener for HandleAbandonedProcessEvent that supports the ProcessStatus.getExecutionType() implement the HandleAbandonedProcessEventListener interface.

Parameters:

processId -

Returns:

setProgress

void setProgress(long count,
                 long total)

Set ProcessStatus.getPercentComplete()

Parameters:

count -

total -

setExecution

void setExecution(Long executionId,
                  String executionType)

Set the information that associates a specific async thread of execution with a ProcessStatus instance. The code in the async thread of execution should call this API to set identifying information (e.g. an entity primary key value and classname). This information can be used by presentation layer code to query for the correct ProcessStatus instance and display progress information about an async thread of execution. This information is not important to the ProcessManager, but is useful if you want to write other code that retrieves a ProcessStatus based on some arbitrary entity that is important for identifying a specific async thread of execution.

Parameters:

executionId - an identifying long id (e.g. the primary key from an entity used in the async thread of execution)

executionType - an identifying tyep value (e.g. the class name from an entity used in the async thread of execution)