com.broadleafcommerce.jobsevents.service

Class ScheduledJobManagerImpl

java.lang.Object

com.broadleafcommerce.jobsevents.service.ScheduledJobManagerImpl

All Implemented Interfaces:

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

@Service(value="blScheduledJobManager")
 @ManagedResource(objectName="org.broadleafcommerce:name=ScheduledJobManager",
                 description="Manages creating SystemEvents for one or more ScheduledJobs",
                 currencyTimeLimit=15)
public class ScheduledJobManagerImpl
extends Object
implements ScheduledJobManager, org.springframework.context.ApplicationContextAware, org.springframework.context.SmartLifecycle

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	context
protected Map<String,SystemEventFactory>	eventFactories
protected DatabaseSystemEventNode	eventNode
protected long	eventPurgeIntervalSeconds
protected boolean	isMaster
protected long	jobThreadPoolCount
protected ConsumeWorker	masterHeartBeatWorker
protected ConsumeWorker	masterIntervalJobWorker
protected long	masterNodeHeartbeatIntervalSeconds
protected boolean	masterNodeJobManagementEnabled
protected ConsumeWorker	masterPurgeEventWorker
protected ConsumeWorker	masterPurgeWorker
protected long	nodePurgeIntervalSeconds
protected long	nodePurgeThresholdSeconds
protected boolean	pause
protected org.quartz.Scheduler	scheduler
protected DatabaseSystemEventDao	systemEventDao
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil
protected List<SystemEventFactory>	unsortedFactories

Constructor Summary

Constructors

Constructor and Description
ScheduledJobManagerImpl(DatabaseSystemEventNode eventNode)

Method Summary

Modifier and Type	Method and Description
protected void	buildScheduler()
Map<String,SystemEventFactory>	getEventFactories() Retrieve the list of factories responsible for creating SystemEvent instances upon job execution.
DatabaseSystemEventNode	getEventNode() This ScheduledJobManager instance is also a node in the cluster.
long	getJobThreadPoolCount() The number of Quartz thread available for jobs execution.
long	getMasterNodeHeartbeatIntervalSeconds() The amount of time between each heartbeat update for this node, if active.
long	getNodePurgeIntervalSeconds() The amount of time between each master purge attempt.
long	getNodePurgeThresholdSeconds() The amount of time an active master is allowed to not update it's heartbeat status before being a purge candidate.
int	getPhase()
org.quartz.Scheduler	getScheduler() Retrieve the internal Quartz scheduler instance.
boolean	isAutoStartup()
boolean	isMaster()
boolean	isMaster(boolean confirmStillMasterNode) Verifies that the current eventNode is the masterNode by retrieving the node designated as master and double checking.
boolean	isPause() Whether this node is paused.
boolean	isRunning()
void	reset() Programatically remove this node from master/active status.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setEventFactories(Map<String,SystemEventFactory> eventFactories)
void	setEventNode(DatabaseSystemEventNode eventNode)
void	setJobThreadPoolCount(long jobThreadPoolCount)
void	setMaster(boolean master)
void	setMasterNodeHeartbeatIntervalSeconds(long masterNodeHeartbeatIntervalSeconds)
void	setNodePurgeIntervalSeconds(long nodePurgeIntervalSeconds)
void	setNodePurgeThresholdSeconds(long nodePurgeThresholdSeconds)
void	setPause(boolean pause)
void	start()
void	stop()
void	stop(Runnable callback)

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

eventNode

protected DatabaseSystemEventNode eventNode

systemEventDao

protected DatabaseSystemEventDao systemEventDao

masterIntervalJobWorker

protected ConsumeWorker masterIntervalJobWorker

masterHeartBeatWorker

protected ConsumeWorker masterHeartBeatWorker

masterPurgeWorker

protected ConsumeWorker masterPurgeWorker

masterPurgeEventWorker

protected ConsumeWorker masterPurgeEventWorker

masterNodeHeartbeatIntervalSeconds

@Value(value="${master.node.heartbeat.interval.seconds:10}")
protected long masterNodeHeartbeatIntervalSeconds

nodePurgeThresholdSeconds

@Value(value="${node.purge.threshold.seconds:60}")
protected long nodePurgeThresholdSeconds

nodePurgeIntervalSeconds

@Value(value="${node.purge.interval.seconds:30}")
protected long nodePurgeIntervalSeconds

eventPurgeIntervalSeconds

@Value(value="${event.purge.interval.seconds:10}")
protected long eventPurgeIntervalSeconds

masterNodeJobManagementEnabled

@Value(value="${master.node.job.management.enabled:true}")
protected boolean masterNodeJobManagementEnabled

unsortedFactories

protected List<SystemEventFactory> unsortedFactories

context

protected org.springframework.context.ApplicationContext context

jobThreadPoolCount

protected long jobThreadPoolCount

scheduler

protected org.quartz.Scheduler scheduler

eventFactories

protected Map<String,SystemEventFactory> eventFactories

pause

protected boolean pause

isMaster

protected boolean isMaster

Constructor Detail

ScheduledJobManagerImpl

@Autowired
public ScheduledJobManagerImpl(@Qualifier(value="blDatabaseSystemEventNode")
                                          DatabaseSystemEventNode eventNode)

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

stop

public void stop()

Specified by:

stop in interface ScheduledJobManager

Specified by:

stop in interface org.springframework.context.Lifecycle

reset

public void reset()

Description copied from interface: ScheduledJobManager

Programatically remove this node from master/active status. This should only be called during a shutdown.

Specified by:

reset in interface ScheduledJobManager

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

getMasterNodeHeartbeatIntervalSeconds

public long getMasterNodeHeartbeatIntervalSeconds()

Description copied from interface: ScheduledJobManager

The amount of time between each heartbeat update for this node, if active. Default is 10.

Specified by:

getMasterNodeHeartbeatIntervalSeconds in interface ScheduledJobManager

Returns:

setMasterNodeHeartbeatIntervalSeconds

public void setMasterNodeHeartbeatIntervalSeconds(long masterNodeHeartbeatIntervalSeconds)

Specified by:

setMasterNodeHeartbeatIntervalSeconds in interface ScheduledJobManager

getNodePurgeThresholdSeconds

@ManagedAttribute(description="Number of seconds a node can miss heartbeat detection before determining that the node has become defunct.",
                  currencyTimeLimit=15)
public long getNodePurgeThresholdSeconds()

Description copied from interface: ScheduledJobManager

The amount of time an active master is allowed to not update it's heartbeat status before being a purge candidate. The default is 60.

Specified by:

getNodePurgeThresholdSeconds in interface ScheduledJobManager

Returns:

setNodePurgeThresholdSeconds

@ManagedAttribute(description="Number of seconds a node can miss heartbeat detection before determining that the node has become defunct.",
                  currencyTimeLimit=15)
public void setNodePurgeThresholdSeconds(long nodePurgeThresholdSeconds)

Specified by:

setNodePurgeThresholdSeconds in interface ScheduledJobManager

getNodePurgeIntervalSeconds

public long getNodePurgeIntervalSeconds()

Description copied from interface: ScheduledJobManager

The amount of time between each master purge attempt. The default is 30.

Specified by:

getNodePurgeIntervalSeconds in interface ScheduledJobManager

Returns:

setNodePurgeIntervalSeconds

public void setNodePurgeIntervalSeconds(long nodePurgeIntervalSeconds)

Specified by:

setNodePurgeIntervalSeconds in interface ScheduledJobManager

isPause

@ManagedAttribute(description="Whether or not job processing is currently paused.",
                  currencyTimeLimit=15)
public boolean isPause()

Description copied from interface: ScheduledJobManager

Whether this node is paused. A paused manager will not update job status and the internal Quartz instances are also paused, resulting in registered jobs not firing.

Specified by:

isPause in interface ScheduledJobManager

Returns:

setPause

@ManagedAttribute(description="Whether or not job processing is currently paused.",
                  currencyTimeLimit=15)
public void setPause(boolean pause)

Specified by:

setPause in interface ScheduledJobManager

getJobThreadPoolCount

public long getJobThreadPoolCount()

Description copied from interface: ScheduledJobManager

The number of Quartz thread available for jobs execution. The default is 20.

Specified by:

getJobThreadPoolCount in interface ScheduledJobManager

Returns:

setJobThreadPoolCount

public void setJobThreadPoolCount(long jobThreadPoolCount)

Specified by:

setJobThreadPoolCount in interface ScheduledJobManager

getEventFactories

public Map<String,SystemEventFactory> getEventFactories()

Description copied from interface: ScheduledJobManager

Retrieve the list of factories responsible for creating SystemEvent instances upon job execution. Jobs, when fired, result in events. Event are then consumed, which is the end goal.

Specified by:

getEventFactories in interface ScheduledJobManager

Returns:

setEventFactories

public void setEventFactories(Map<String,SystemEventFactory> eventFactories)

Specified by:

setEventFactories in interface ScheduledJobManager

isMaster

public boolean isMaster()

Specified by:

isMaster in interface ScheduledJobManager

isMaster

public boolean isMaster(boolean confirmStillMasterNode)

Description copied from interface: ScheduledJobManager

Verifies that the current eventNode is the masterNode by retrieving the node designated as master and double checking. If the node was marked as the master and confirmed to not be the master, the master is reset via the setMaster() method.

Specified by:

isMaster in interface ScheduledJobManager

Returns:

setMaster

public void setMaster(boolean master)

Specified by:

setMaster in interface ScheduledJobManager

getScheduler

public org.quartz.Scheduler getScheduler()

Description copied from interface: ScheduledJobManager

Retrieve the internal Quartz scheduler instance.

Specified by:

getScheduler in interface ScheduledJobManager

Returns:

getEventNode

public DatabaseSystemEventNode getEventNode()

Description copied from interface: ScheduledJobManager

This ScheduledJobManager instance is also a node in the cluster. Retrieve the associated DatabaseSystemEventNode instance.

Specified by:

getEventNode in interface ScheduledJobManager

Returns:

setEventNode

public void setEventNode(DatabaseSystemEventNode eventNode)

Specified by:

setEventNode in interface ScheduledJobManager

buildScheduler

protected void buildScheduler()
                       throws IOException,
                              org.quartz.SchedulerException

Throws:

IOException

org.quartz.SchedulerException