com.broadleafcommerce.jobsevents.service

Class ProcessManagerImpl

java.lang.Object

com.broadleafcommerce.jobsevents.service.ProcessManagerImpl

All Implemented Interfaces:

ProcessManager, EventListener, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

@Service(value="blProcessManager")
public class ProcessManagerImpl
extends Object
implements org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>, ProcessManager

Author:

Jeff Fischer

See Also:

ProcessManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessManagerImpl.KeepAliveJob

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.profile.core.service.IdGenerationService	idGenerationService
protected long	jobThreadPoolCount
protected ProcessDao	processDao
protected Map<Long,ProcessStatus>	processes
protected boolean	processManagerEnabled
protected long	processManagerStatusUpdateIntervalSeconds
protected org.quartz.Scheduler	scheduler
protected org.springframework.transaction.PlatformTransactionManager	transactionManager
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil

Constructor Summary

Constructors

Constructor and Description
ProcessManagerImpl()

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	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
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	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()
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

transactionManager

protected org.springframework.transaction.PlatformTransactionManager transactionManager

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.profile.core.service.IdGenerationService idGenerationService

processDao

protected ProcessDao processDao

applicationEventMulticaster

protected org.springframework.context.event.ApplicationEventMulticaster applicationEventMulticaster

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

ProcessManagerImpl

public ProcessManagerImpl()

Method Detail

onApplicationEvent

public void onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

stop

@PreDestroy
public void stop()

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: ProcessManager

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 ProcessManager

startProcess

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

Description copied from interface: ProcessManager

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

Specified by:

startProcess in interface ProcessManager

startProcess

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

Description copied from interface: ProcessManager

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

Specified by:

startProcess in interface ProcessManager

startProcess

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

Description copied from interface: ProcessManager

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

Specified by:

startProcess in interface ProcessManager

startProcess

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

Description copied from interface: ProcessManager

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

Specified by:

startProcess in interface ProcessManager

endProcess

public void endProcess()

Description copied from interface: ProcessManager

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 ProcessManager

pauseProcess

public void pauseProcess()

Description copied from interface: ProcessManager

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

Specified by:

pauseProcess in interface ProcessManager

dropProcess

public void dropProcess()

Description copied from interface: ProcessManager

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 ProcessManager

setProgress

public void setProgress(long count,
                        long total)

Description copied from interface: ProcessManager

Set ProcessStatus.getPercentComplete()

Specified by:

setProgress in interface ProcessManager

setExecution

public void setExecution(Long executionId,
                         String executionType)

Description copied from interface: ProcessManager

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.

Specified by:

setExecution in interface ProcessManager

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: ProcessManager

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 ProcessManager

supportsResume

public boolean supportsResume(Long processId)

Description copied from interface: ProcessManager

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 ProcessManager

Returns:

getProcesses

public Map<Long,ProcessStatus> getProcesses()

Description copied from interface: ProcessManager

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

Specified by:

getProcesses in interface ProcessManager

Returns: