com.broadleafcommerce.jobsevents.service

Class ScheduledDeployManagerImpl

java.lang.Object

com.broadleafcommerce.jobsevents.service.ScheduledDeployManagerImpl

All Implemented Interfaces:

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

@Service(value="blScheduledDeployManager")
 @ManagedResource(objectName="org.broadleafcommerce:name=ScheduledDeployManager",
                 description="Manages processing of scheduled deployments",
                 currencyTimeLimit=15)
public class ScheduledDeployManagerImpl
extends Object
implements ScheduledDeployManager, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationListener<org.springframework.context.event.ContextRefreshedEvent>

Author:

Jeff Fischer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduledDeployManagerImpl.ConsumeJob
static class	ScheduledDeployManagerImpl.HeartBeatJob
static class	ScheduledDeployManagerImpl.PurgeMasterJob

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	context
protected Map<String,SystemEventFactory>	eventFactories
protected DatabaseSystemEventNode	eventNode
protected boolean	isMaster
protected long	jobThreadPoolCount
protected boolean	masterDeployNodeEnabled
protected long	masterNodeHeartbeatIntervalSeconds Number of seconds between each hearbeat check event for a node.
protected long	nodePurgeIntervalSeconds Number of seconds between each polling attempt to the database in search of defunct nodes to purge.
protected long	nodePurgeThresholdSeconds Number of seconds a node can miss heartbeat detection before determining that the node has become defunct.
protected boolean	pause
protected long	pollingIntervalSeconds Number of seconds between each polling attempt to the database in search of new deploy system events to process.
protected org.quartz.Scheduler	scheduler
protected DatabaseSystemEventDao	systemEventDao
protected org.springframework.transaction.PlatformTransactionManager	transactionManager
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil

Constructor Summary

Constructors

Constructor and Description
ScheduledDeployManagerImpl()

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	onApplicationEvent(org.springframework.context.event.ContextRefreshedEvent event)
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	stop()
protected void	suspend(boolean pause)

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

eventNode

protected DatabaseSystemEventNode eventNode

systemEventDao

protected DatabaseSystemEventDao systemEventDao

masterNodeHeartbeatIntervalSeconds

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

Number of seconds between each hearbeat check event for a node. During this check, a node has the opportunity to ascend to master status if there isn't a master, or if the current master is determined to be defunct.

Default property and value: master.deploy.node.heartbeat.interval.seconds=10

nodePurgeThresholdSeconds

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

Number of seconds a node can miss heartbeat detection before determining that the node has become defunct.

Default property and value: deploy.node.purge.threshold.seconds=60

nodePurgeIntervalSeconds

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

Number of seconds between each polling attempt to the database in search of defunct nodes to purge.

Default property and value: deploy.node.purge.interval.seconds=30

pollingIntervalSeconds

@Value(value="${database.deploy.event.polling.interval.seconds:5}")
protected long pollingIntervalSeconds

Number of seconds between each polling attempt to the database in search of new deploy system events to process. Only applicable for database-based event implementations, which is the default. Other implementations, such as JMS, may be used instead. Note, if processing of the last batch of events took longer than 5 seconds, then the system will poll again immediately. This setting comes mostly into play when there are no events to process, and the system will wait 5 seconds (by default) to check again for any new events.

Default property and value: database.deploy.event.polling.interval.seconds=5

masterDeployNodeEnabled

@Value(value="${master.deploy.node.enabled:true}")
protected boolean masterDeployNodeEnabled

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

ScheduledDeployManagerImpl

public ScheduledDeployManagerImpl()

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()

Specified by:

stop in interface ScheduledDeployManager

reset

public void reset()

Description copied from interface: ScheduledDeployManager

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

Specified by:

reset in interface ScheduledDeployManager

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

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

Specified by:

getMasterNodeHeartbeatIntervalSeconds in interface ScheduledDeployManager

Returns:

setMasterNodeHeartbeatIntervalSeconds

public void setMasterNodeHeartbeatIntervalSeconds(long masterNodeHeartbeatIntervalSeconds)

Specified by:

setMasterNodeHeartbeatIntervalSeconds in interface ScheduledDeployManager

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

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 ScheduledDeployManager

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 ScheduledDeployManager

getNodePurgeIntervalSeconds

public long getNodePurgeIntervalSeconds()

Description copied from interface: ScheduledDeployManager

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

Specified by:

getNodePurgeIntervalSeconds in interface ScheduledDeployManager

Returns:

setNodePurgeIntervalSeconds

public void setNodePurgeIntervalSeconds(long nodePurgeIntervalSeconds)

Specified by:

setNodePurgeIntervalSeconds in interface ScheduledDeployManager

isPause

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

Description copied from interface: ScheduledDeployManager

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 ScheduledDeployManager

Returns:

setPause

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

Specified by:

setPause in interface ScheduledDeployManager

getJobThreadPoolCount

public long getJobThreadPoolCount()

Description copied from interface: ScheduledDeployManager

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

Specified by:

getJobThreadPoolCount in interface ScheduledDeployManager

Returns:

setJobThreadPoolCount

public void setJobThreadPoolCount(long jobThreadPoolCount)

Specified by:

setJobThreadPoolCount in interface ScheduledDeployManager

getEventFactories

public Map<String,SystemEventFactory> getEventFactories()

Description copied from interface: ScheduledDeployManager

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 ScheduledDeployManager

Returns:

setEventFactories

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

Specified by:

setEventFactories in interface ScheduledDeployManager

isMaster

public boolean isMaster()

Specified by:

isMaster in interface ScheduledDeployManager

setMaster

public void setMaster(boolean master)

Specified by:

setMaster in interface ScheduledDeployManager

getScheduler

public org.quartz.Scheduler getScheduler()

Description copied from interface: ScheduledDeployManager

Retrieve the internal Quartz scheduler instance.

Specified by:

getScheduler in interface ScheduledDeployManager

Returns:

getEventNode

public DatabaseSystemEventNode getEventNode()

Description copied from interface: ScheduledDeployManager

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

Specified by:

getEventNode in interface ScheduledDeployManager

Returns:

setEventNode

public void setEventNode(DatabaseSystemEventNode eventNode)

Specified by:

setEventNode in interface ScheduledDeployManager

suspend

protected void suspend(boolean pause)