com.broadleafcommerce.jobsevents.service

Class ProcessStatusManagerImpl

java.lang.Object

com.broadleafcommerce.jobsevents.service.ProcessStatusManagerImpl

All Implemented Interfaces:

ProcessStatusManager, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

@Service(value="blProcessStatusManager")
public class ProcessStatusManagerImpl
extends Object
implements org.springframework.context.ApplicationContextAware, ProcessStatusManager, org.springframework.context.SmartLifecycle

Author:

Jeff Fischer

See Also:

ProcessStatusManager

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.event.ApplicationEventMulticaster	applicationEventMulticaster
protected org.springframework.context.ApplicationContext	context
protected org.broadleafcommerce.common.id.service.IdGenerationService	idGenerationService
protected long	jobThreadPoolCount
protected Map<Long,ProcessStatus>	processes
protected ConsumeWorker	processGroomWorker
protected ConsumeWorker	processKeepAliveWorker
protected ProcessManagementDao	processManagementDao
protected boolean	processManagerEnabled
protected long	processManagerStatusUpdateIntervalSeconds
protected org.quartz.Scheduler	scheduler
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
ProcessStatusManagerImpl()

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.
void	endProcess(boolean immediateRemove) Finish a process when the async thread of execution is complete.
int	getPhase()
Map<Long,ProcessStatus>	getProcesses() Return the list of currently active processes on this server.
boolean	isAutoStartup()
boolean	isRunning()
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	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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	start()
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.
void	stop()
void	stop(Runnable callback)
boolean	supportsResume(Long processId) Detects if a ProcessStatus can be resumed.
void	unPauseProcess(Long processId) Sets the isPaused state to false for the ProcessStatus.

Methods inherited from class java.lang.Object

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

Field Detail

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

processManagerEnabled

@Value(value="${process.manager.enabled:true}")
protected boolean processManagerEnabled

processManagerStatusUpdateIntervalSeconds

@Value(value="${process.manager.status.update.interval.seconds:5}")
protected long processManagerStatusUpdateIntervalSeconds

idGenerationService

protected org.broadleafcommerce.common.id.service.IdGenerationService idGenerationService

processManagementDao

protected ProcessManagementDao processManagementDao

applicationEventMulticaster

protected org.springframework.context.event.ApplicationEventMulticaster applicationEventMulticaster

processKeepAliveWorker

protected ConsumeWorker processKeepAliveWorker

processGroomWorker

protected ConsumeWorker processGroomWorker

context

protected org.springframework.context.ApplicationContext context

jobThreadPoolCount

protected long jobThreadPoolCount

scheduler

protected org.quartz.Scheduler scheduler

processes

protected Map<Long,ProcessStatus> processes

Constructor Detail

ProcessStatusManagerImpl

public ProcessStatusManagerImpl()

Method Detail

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

startProcess

public void startProcess(SystemEvent event)

Description copied from interface: ProcessStatusManager

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

Specified by:

startProcess in interface ProcessStatusManager

startProcess

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

Description copied from interface: ProcessStatusManager

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

Specified by:

startProcess in interface ProcessStatusManager

startProcess

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

Description copied from interface: ProcessStatusManager

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

Specified by:

startProcess in interface ProcessStatusManager

startProcess

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

Description copied from interface: ProcessStatusManager

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

Specified by:

startProcess in interface ProcessStatusManager

startProcess

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

Description copied from interface: ProcessStatusManager

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

Specified by:

startProcess in interface ProcessStatusManager

endProcess

public void endProcess()

Description copied from interface: ProcessStatusManager

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.

Specified by:

endProcess in interface ProcessStatusManager

endProcess

public void endProcess(boolean immediateRemove)

Description copied from interface: ProcessStatusManager

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. If immediateRemove is true, then the ProcessStatus is deleted from the table, rather than archiving the record.

Specified by:

endProcess in interface ProcessStatusManager

pauseProcess

public void pauseProcess()

Description copied from interface: ProcessStatusManager

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 ProcessStatusManager.unPauseProcess(Long) method is called.

Specified by:

pauseProcess in interface ProcessStatusManager

dropProcess

public void dropProcess()

Description copied from interface: ProcessStatusManager

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.

Specified by:

dropProcess in interface ProcessStatusManager

setProgress

public void setProgress(long count,
                        long total)

Description copied from interface: ProcessStatusManager

Set ProcessStatus.getPercentComplete()

Specified by:

setProgress in interface ProcessStatusManager

setExecution

public void setExecution(Long executionId,
                         String executionType)

Description copied from interface: ProcessStatusManager

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 ProcessStatusManager, 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.

Specified by:

setExecution in interface ProcessStatusManager

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)

unPauseProcess

public void unPauseProcess(Long processId)

Description copied from interface: ProcessStatusManager

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.

Specified by:

unPauseProcess in interface ProcessStatusManager

supportsResume

public boolean supportsResume(Long processId)

Description copied from interface: ProcessStatusManager

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.

Specified by:

supportsResume in interface ProcessStatusManager

Returns:

getProcesses

public Map<Long,ProcessStatus> getProcesses()

Description copied from interface: ProcessStatusManager

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

Specified by:

getProcesses in interface ProcessStatusManager

Returns: