com.broadleafcommerce.jobsevents.service

Interface ScheduledJobManager

All Known Implementing Classes:

ScheduledJobManagerImpl

public interface ScheduledJobManager

Responsible for managing ScheduledJob instances. There is only ever one active ScheduledJobManager in the cluster (the master). If the current master fails, another node may become active (master/slave HA config).

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method and Description
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.
org.quartz.Scheduler	getScheduler() Retrieve the internal Quartz scheduler instance.
boolean	isMaster()
boolean	isPause() Whether this node is paused.
void	reset() Programatically remove this node from master/active status.
void	setEventFactories(Map<String,SystemEventFactory> eventFactories)
void	setEventNode(DatabaseSystemEventNode eventNode)
void	setJobThreadPoolCount(long jobThreadPoolCount)
void	setMaster(boolean master)
void	setMasterNodeHeartbeatIntervalSeconds(long masterNodeHeartbeatInterval)
void	setNodePurgeIntervalSeconds(long masterNodePurgeInterval)
void	setNodePurgeThresholdSeconds(long masterNodePurgeThreshold)
void	setPause(boolean pause)

Method Detail

getMasterNodeHeartbeatIntervalSeconds

long getMasterNodeHeartbeatIntervalSeconds()

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

Returns:

setMasterNodeHeartbeatIntervalSeconds

void setMasterNodeHeartbeatIntervalSeconds(long masterNodeHeartbeatInterval)

getNodePurgeThresholdSeconds

long getNodePurgeThresholdSeconds()

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.

Returns:

setNodePurgeThresholdSeconds

void setNodePurgeThresholdSeconds(long masterNodePurgeThreshold)

getNodePurgeIntervalSeconds

long getNodePurgeIntervalSeconds()

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

Returns:

setNodePurgeIntervalSeconds

void setNodePurgeIntervalSeconds(long masterNodePurgeInterval)

isPause

boolean isPause()

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.

Returns:

setPause

void setPause(boolean pause)

getJobThreadPoolCount

long getJobThreadPoolCount()

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

Returns:

setJobThreadPoolCount

void setJobThreadPoolCount(long jobThreadPoolCount)

reset

void reset()

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

isMaster

boolean isMaster()

setMaster

void setMaster(boolean master)

getEventFactories

Map<String,SystemEventFactory> getEventFactories()

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.

Returns:

setEventFactories

void setEventFactories(Map<String,SystemEventFactory> eventFactories)

getScheduler

org.quartz.Scheduler getScheduler()

Retrieve the internal Quartz scheduler instance.

Returns:

getEventNode

DatabaseSystemEventNode getEventNode()

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

Returns:

setEventNode

void setEventNode(DatabaseSystemEventNode eventNode)