net.joelinn.quartz.jobstore

Class RedisJobStore

java.lang.Object

net.joelinn.quartz.jobstore.RedisJobStore

All Implemented Interfaces:

org.quartz.spi.JobStore

public class RedisJobStore
extends Object
implements org.quartz.spi.JobStore

Joe Linn 7/12/2014

Field Summary

Fields

Modifier and Type	Field and Description
protected int	conRetries connection retries counter
protected int	conTimeout socket connection timeout in ms
protected short	database Redis database
protected String	host Redis host
protected String	instanceId
protected String	keyDelimiter Redis key delimiter
protected String	keyPrefix Redis key prefix
protected int	lockTimeout Redis lock timeout in milliseconds
protected String	masterGroupName Redis sentinel master group name
protected String	password Redis password
protected int	port Redis port
protected int	soTimeout socket timeout in ms
protected boolean	ssl ssl flag
protected AbstractRedisStorage	storage

Constructor Summary

Constructors

Constructor and Description
RedisJobStore()

Method Summary

Modifier and Type	Method and Description
List<org.quartz.spi.OperableTrigger>	acquireNextTriggers(long noLaterThan, int maxCount, long timeWindow) Get a handle to the next trigger to be fired, and mark it as 'reserved' by the calling scheduler.
boolean	checkExists(org.quartz.JobKey jobKey) Determine whether a Job with the given identifier already exists within the scheduler.
boolean	checkExists(org.quartz.TriggerKey triggerKey) Determine whether a Trigger with the given identifier already exists within the scheduler.
void	clearAllSchedulingData() Clear (delete!) all scheduling data - all Jobs, Triggers Calendars.
List<String>	getCalendarNames() Get the names of all of the Calendar s in the JobStore.
long	getEstimatedTimeToReleaseAndAcquireTrigger() How long (in milliseconds) the JobStore implementation estimates that it will take to release a trigger and acquire a new one.
List<String>	getJobGroupNames() Get the names of all of the Job groups.
Set<org.quartz.JobKey>	getJobKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher) Get the keys of all of the Job s that have the given group name.
int	getNumberOfCalendars() Get the number of Calendar s that are stored in the JobsStore.
int	getNumberOfJobs() Get the number of Job s that are stored in the JobsStore.
int	getNumberOfTriggers() Get the number of Trigger s that are stored in the JobsStore.
String	getPassword()
Set<String>	getPausedTriggerGroups()
List<String>	getTriggerGroupNames() Get the names of all of the Trigger groups.
Set<org.quartz.TriggerKey>	getTriggerKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher) Get the names of all of the Trigger s that have the given group name.
List<org.quartz.spi.OperableTrigger>	getTriggersForJob(org.quartz.JobKey jobKey) Get all of the Triggers that are associated to the given Job.
org.quartz.Trigger.TriggerState	getTriggerState(org.quartz.TriggerKey triggerKey) Get the current state of the identified Trigger.
void	initialize(org.quartz.spi.ClassLoadHelper loadHelper, org.quartz.spi.SchedulerSignaler signaler) Called by the QuartzScheduler before the JobStore is used, in order to give the it a chance to initialize.
boolean	isClustered() Whether or not the JobStore implementation is redisCluster.
void	pauseAll() Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.
void	pauseJob(org.quartz.JobKey jobKey) Pause the Job with the given name - by pausing all of its current Triggers.
Collection<String>	pauseJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher) Pause all of the Jobs in the given group - by pausing all of their Triggers.
void	pauseTrigger(org.quartz.TriggerKey triggerKey) Pause the Trigger with the given key.
Collection<String>	pauseTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher) Pause all of the Triggers in the given group.
void	releaseAcquiredTrigger(org.quartz.spi.OperableTrigger trigger) Inform the JobStore that the scheduler no longer plans to fire the given Trigger, that it had previously acquired (reserved).
boolean	removeCalendar(String calName) Remove (delete) the Calendar with the given name.
boolean	removeJob(org.quartz.JobKey jobKey) Remove (delete) the Job with the given key, and any Trigger s that reference it.
boolean	removeJobs(List<org.quartz.JobKey> jobKeys)
boolean	removeTrigger(org.quartz.TriggerKey triggerKey) Remove (delete) the Trigger with the given key.
boolean	removeTriggers(List<org.quartz.TriggerKey> triggerKeys)
boolean	replaceTrigger(org.quartz.TriggerKey triggerKey, org.quartz.spi.OperableTrigger newTrigger) Remove (delete) the Trigger with the given key, and store the new given one - which must be associated with the same job.
void	resumeAll() Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.
void	resumeJob(org.quartz.JobKey jobKey) Resume (un-pause) the Job with the given key.
Collection<String>	resumeJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher) Resume (un-pause) all of the Jobs in the given group.
void	resumeTrigger(org.quartz.TriggerKey triggerKey) Resume (un-pause) the Trigger with the given key.
Collection<String>	resumeTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher) Resume (un-pause) all of the Triggers in the given group.
org.quartz.Calendar	retrieveCalendar(String calName) Retrieve the given Trigger.
org.quartz.JobDetail	retrieveJob(org.quartz.JobKey jobKey) Retrieve the JobDetail for the given Job.
org.quartz.spi.OperableTrigger	retrieveTrigger(org.quartz.TriggerKey triggerKey) Retrieve the given Trigger.
void	schedulerPaused() Called by the QuartzScheduler to inform the JobStore that the scheduler has been paused.
void	schedulerResumed() Called by the QuartzScheduler to inform the JobStore that the scheduler has resumed after being paused.
void	schedulerStarted() Called by the QuartzScheduler to inform the JobStore that the scheduler has started.
void	setDatabase(int database)
void	setDatabase(String database)
void	setHost(String host)
void	setInstanceId(String schedInstId) Inform the JobStore of the Scheduler instance's Id, prior to initialize being invoked.
void	setInstanceName(String schedName) Inform the JobStore of the Scheduler instance's name, prior to initialize being invoked.
RedisJobStore	setJedisCluster(redis.clients.jedis.JedisCluster jedisCluster)
RedisJobStore	setJedisPool(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool)
void	setKeyDelimiter(String keyDelimiter)
void	setKeyPrefix(String keyPrefix)
void	setLockTimeout(int lockTimeout)
void	setLockTimeout(String lockTimeout)
void	setMasterGroupName(String masterGroupName)
void	setMisfireThreshold(int misfireThreshold)
void	setPassword(String password)
void	setPort(int port)
void	setPort(String port)
void	setRedisCluster(boolean clustered)
void	setRedisSentinel(boolean sentinel)
void	setSsl(boolean ssl)
void	setSsl(String ssl)
void	setThreadPoolSize(int poolSize) Tells the JobStore the pool size used to execute jobs
void	shutdown() Called by the QuartzScheduler to inform the JobStore that it should free up all of it's resources because the scheduler is shutting down.
void	storeCalendar(String name, org.quartz.Calendar calendar, boolean replaceExisting, boolean updateTriggers) Store the given Calendar.
void	storeJob(org.quartz.JobDetail newJob, boolean replaceExisting) Store the given JobDetail.
void	storeJobAndTrigger(org.quartz.JobDetail newJob, org.quartz.spi.OperableTrigger newTrigger) Store the given JobDetail and Trigger.
void	storeJobsAndTriggers(Map<org.quartz.JobDetail,Set<? extends org.quartz.Trigger>> triggersAndJobs, boolean replace)
void	storeTrigger(org.quartz.spi.OperableTrigger newTrigger, boolean replaceExisting) Store the given Trigger.
boolean	supportsPersistence()
void	triggeredJobComplete(org.quartz.spi.OperableTrigger trigger, org.quartz.JobDetail jobDetail, org.quartz.Trigger.CompletedExecutionInstruction triggerInstCode) Inform the JobStore that the scheduler has completed the firing of the given Trigger (and the execution of its associated Job completed, threw an exception, or was vetoed), and that the JobDataMap in the given JobDetail should be updated if the Job is stateful.
List<org.quartz.spi.TriggerFiredResult>	triggersFired(List<org.quartz.spi.OperableTrigger> triggers) Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Methods inherited from class java.lang.Object

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

Field Detail

lockTimeout

protected int lockTimeout

Redis lock timeout in milliseconds

host

protected String host

Redis host

port

protected int port

Redis port

password

protected String password

Redis password

database

protected short database

Redis database

masterGroupName

protected String masterGroupName

Redis sentinel master group name

keyPrefix

protected String keyPrefix

Redis key prefix

keyDelimiter

protected String keyDelimiter

Redis key delimiter

instanceId

protected String instanceId

storage

protected AbstractRedisStorage storage

conTimeout

protected int conTimeout

socket connection timeout in ms

conRetries

protected int conRetries

connection retries counter

soTimeout

protected int soTimeout

socket timeout in ms

ssl

protected boolean ssl

ssl flag

Constructor Detail

RedisJobStore

public RedisJobStore()

Method Detail

setJedisPool

public RedisJobStore setJedisPool(redis.clients.util.Pool<redis.clients.jedis.Jedis> jedisPool)

setJedisCluster

public RedisJobStore setJedisCluster(redis.clients.jedis.JedisCluster jedisCluster)

setMisfireThreshold

public void setMisfireThreshold(int misfireThreshold)

initialize

public void initialize(org.quartz.spi.ClassLoadHelper loadHelper,
                       org.quartz.spi.SchedulerSignaler signaler)
                throws org.quartz.SchedulerConfigException

Called by the QuartzScheduler before the JobStore is used, in order to give the it a chance to initialize.

Specified by:

initialize in interface org.quartz.spi.JobStore

Parameters:

loadHelper - class loader helper

signaler - schedule signaler object

Throws:

org.quartz.SchedulerConfigException

schedulerStarted

public void schedulerStarted()
                      throws org.quartz.SchedulerException

Called by the QuartzScheduler to inform the JobStore that the scheduler has started.

Specified by:

schedulerStarted in interface org.quartz.spi.JobStore

Throws:

org.quartz.SchedulerException

schedulerPaused

public void schedulerPaused()

Called by the QuartzScheduler to inform the JobStore that the scheduler has been paused.

Specified by:

schedulerPaused in interface org.quartz.spi.JobStore

schedulerResumed

public void schedulerResumed()

Called by the QuartzScheduler to inform the JobStore that the scheduler has resumed after being paused.

Specified by:

schedulerResumed in interface org.quartz.spi.JobStore

shutdown

public void shutdown()

Called by the QuartzScheduler to inform the JobStore that it should free up all of it's resources because the scheduler is shutting down.

Specified by:

shutdown in interface org.quartz.spi.JobStore

supportsPersistence

public boolean supportsPersistence()

Specified by:

supportsPersistence in interface org.quartz.spi.JobStore

getEstimatedTimeToReleaseAndAcquireTrigger

public long getEstimatedTimeToReleaseAndAcquireTrigger()

How long (in milliseconds) the JobStore implementation estimates that it will take to release a trigger and acquire a new one.

Specified by:

getEstimatedTimeToReleaseAndAcquireTrigger in interface org.quartz.spi.JobStore

isClustered

public boolean isClustered()

Whether or not the JobStore implementation is redisCluster.

Specified by:

isClustered in interface org.quartz.spi.JobStore

storeJobAndTrigger

public void storeJobAndTrigger(org.quartz.JobDetail newJob,
                               org.quartz.spi.OperableTrigger newTrigger)
                        throws org.quartz.ObjectAlreadyExistsException,
                               org.quartz.JobPersistenceException

Store the given JobDetail and Trigger.

Specified by:

storeJobAndTrigger in interface org.quartz.spi.JobStore

Parameters:

newJob - The JobDetail to be stored.

newTrigger - The Trigger to be stored.

Throws:

org.quartz.ObjectAlreadyExistsException - if a Job with the same name/group already exists.

org.quartz.JobPersistenceException

storeJob

public void storeJob(org.quartz.JobDetail newJob,
                     boolean replaceExisting)
              throws org.quartz.ObjectAlreadyExistsException,
                     org.quartz.JobPersistenceException

Store the given JobDetail.

Specified by:

storeJob in interface org.quartz.spi.JobStore

Parameters:

newJob - The JobDetail to be stored.

replaceExisting - If true, any Job existing in the JobStore with the same name & group should be over-written.

Throws:

org.quartz.ObjectAlreadyExistsException - if a Job with the same name/group already exists, and replaceExisting is set to false.

org.quartz.JobPersistenceException

storeJobsAndTriggers

public void storeJobsAndTriggers(Map<org.quartz.JobDetail,Set<? extends org.quartz.Trigger>> triggersAndJobs,
                                 boolean replace)
                          throws org.quartz.ObjectAlreadyExistsException,
                                 org.quartz.JobPersistenceException

Specified by:

storeJobsAndTriggers in interface org.quartz.spi.JobStore

Throws:

org.quartz.ObjectAlreadyExistsException

org.quartz.JobPersistenceException

removeJob

public boolean removeJob(org.quartz.JobKey jobKey)
                  throws org.quartz.JobPersistenceException

Remove (delete) the Job with the given key, and any Trigger s that reference it.

If removal of the Job results in an empty group, the group should be removed from the JobStore's list of known group names.

Specified by:

removeJob in interface org.quartz.spi.JobStore

Parameters:

jobKey - the key of the job to be removed

Returns:

true if a Job with the given name & group was found and removed from the store.

Throws:

org.quartz.JobPersistenceException

removeJobs

public boolean removeJobs(List<org.quartz.JobKey> jobKeys)
                   throws org.quartz.JobPersistenceException

Specified by:

removeJobs in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

retrieveJob

public org.quartz.JobDetail retrieveJob(org.quartz.JobKey jobKey)
                                 throws org.quartz.JobPersistenceException

Retrieve the JobDetail for the given Job.

Specified by:

retrieveJob in interface org.quartz.spi.JobStore

Parameters:

jobKey - the JobKey describing the desired job

Returns:

The desired Job, or null if there is no match.

Throws:

org.quartz.JobPersistenceException

storeTrigger

public void storeTrigger(org.quartz.spi.OperableTrigger newTrigger,
                         boolean replaceExisting)
                  throws org.quartz.ObjectAlreadyExistsException,
                         org.quartz.JobPersistenceException

Store the given Trigger.

Specified by:

storeTrigger in interface org.quartz.spi.JobStore

Parameters:

newTrigger - The Trigger to be stored.

replaceExisting - If true, any Trigger existing in the JobStore with the same name & group should be over-written.

Throws:

org.quartz.ObjectAlreadyExistsException - if a Trigger with the same name/group already exists, and replaceExisting is set to false.

org.quartz.JobPersistenceException

See Also:

pauseTriggers(org.quartz.impl.matchers.GroupMatcher)

removeTrigger

public boolean removeTrigger(org.quartz.TriggerKey triggerKey)
                      throws org.quartz.JobPersistenceException

Remove (delete) the Trigger with the given key.

If removal of the Trigger results in an empty group, the group should be removed from the JobStore's list of known group names.

If removal of the Trigger results in an 'orphaned' Job that is not 'durable', then the Job should be deleted also.

Specified by:

removeTrigger in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key of the trigger to be removed

Returns:

true if a Trigger with the given name & group was found and removed from the store.

Throws:

org.quartz.JobPersistenceException

removeTriggers

public boolean removeTriggers(List<org.quartz.TriggerKey> triggerKeys)
                       throws org.quartz.JobPersistenceException

Specified by:

removeTriggers in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

replaceTrigger

public boolean replaceTrigger(org.quartz.TriggerKey triggerKey,
                              org.quartz.spi.OperableTrigger newTrigger)
                       throws org.quartz.JobPersistenceException

Remove (delete) the Trigger with the given key, and store the new given one - which must be associated with the same job.

Specified by:

replaceTrigger in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key of the trigger to be replaced

newTrigger - The new Trigger to be stored.

Returns:

true if a Trigger with the given name & group was found and removed from the store.

Throws:

org.quartz.JobPersistenceException

retrieveTrigger

public org.quartz.spi.OperableTrigger retrieveTrigger(org.quartz.TriggerKey triggerKey)
                                               throws org.quartz.JobPersistenceException

Retrieve the given Trigger.

Specified by:

retrieveTrigger in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key of the desired trigger

Returns:

The desired Trigger, or null if there is no match.

Throws:

org.quartz.JobPersistenceException

checkExists

public boolean checkExists(org.quartz.JobKey jobKey)
                    throws org.quartz.JobPersistenceException

Determine whether a Job with the given identifier already exists within the scheduler.

Specified by:

checkExists in interface org.quartz.spi.JobStore

Parameters:

jobKey - the identifier to check for

Returns:

true if a Job exists with the given identifier

Throws:

org.quartz.JobPersistenceException

checkExists

public boolean checkExists(org.quartz.TriggerKey triggerKey)
                    throws org.quartz.JobPersistenceException

Determine whether a Trigger with the given identifier already exists within the scheduler.

Specified by:

checkExists in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the identifier to check for

Returns:

true if a Trigger exists with the given identifier

Throws:

org.quartz.JobPersistenceException

clearAllSchedulingData

public void clearAllSchedulingData()
                            throws org.quartz.JobPersistenceException

Clear (delete!) all scheduling data - all Jobs, Triggers Calendars.

Specified by:

clearAllSchedulingData in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

storeCalendar

public void storeCalendar(String name,
                          org.quartz.Calendar calendar,
                          boolean replaceExisting,
                          boolean updateTriggers)
                   throws org.quartz.ObjectAlreadyExistsException,
                          org.quartz.JobPersistenceException

Store the given Calendar.

Specified by:

storeCalendar in interface org.quartz.spi.JobStore

Parameters:

name - The name of the calendar

calendar - The Calendar to be stored.

replaceExisting - If true, any Calendar existing in the JobStore with the same name & group should be over-written.

updateTriggers - If true, any Triggers existing in the JobStore that reference an existing Calendar with the same name with have their next fire time re-computed with the new Calendar.

Throws:

org.quartz.ObjectAlreadyExistsException - if a Calendar with the same name already exists, and replaceExisting is set to false.

org.quartz.JobPersistenceException

removeCalendar

public boolean removeCalendar(String calName)
                       throws org.quartz.JobPersistenceException

Remove (delete) the Calendar with the given name.

If removal of the Calendar would result in Triggers pointing to non-existent calendars, then a JobPersistenceException will be thrown.

*

Specified by:

removeCalendar in interface org.quartz.spi.JobStore

Parameters:

calName - The name of the Calendar to be removed.

Returns:

true if a Calendar with the given name was found and removed from the store.

Throws:

org.quartz.JobPersistenceException

retrieveCalendar

public org.quartz.Calendar retrieveCalendar(String calName)
                                     throws org.quartz.JobPersistenceException

Retrieve the given Trigger.

Specified by:

retrieveCalendar in interface org.quartz.spi.JobStore

Parameters:

calName - The name of the Calendar to be retrieved.

Returns:

The desired Calendar, or null if there is no match.

Throws:

org.quartz.JobPersistenceException

getNumberOfJobs

public int getNumberOfJobs()
                    throws org.quartz.JobPersistenceException

Get the number of Job s that are stored in the JobsStore.

Specified by:

getNumberOfJobs in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getNumberOfTriggers

public int getNumberOfTriggers()
                        throws org.quartz.JobPersistenceException

Get the number of Trigger s that are stored in the JobsStore.

Specified by:

getNumberOfTriggers in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getNumberOfCalendars

public int getNumberOfCalendars()
                         throws org.quartz.JobPersistenceException

Get the number of Calendar s that are stored in the JobsStore.

Specified by:

getNumberOfCalendars in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getJobKeys

public Set<org.quartz.JobKey> getJobKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher)
                                  throws org.quartz.JobPersistenceException

Get the keys of all of the Job s that have the given group name.

If there are no jobs in the given group name, the result should be an empty collection (not null).

Specified by:

getJobKeys in interface org.quartz.spi.JobStore

Parameters:

matcher - the matcher for job key comparison

Throws:

org.quartz.JobPersistenceException

getTriggerKeys

public Set<org.quartz.TriggerKey> getTriggerKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher)
                                          throws org.quartz.JobPersistenceException

Get the names of all of the Trigger s that have the given group name.

If there are no triggers in the given group name, the result should be a zero-length array (not null).

Specified by:

getTriggerKeys in interface org.quartz.spi.JobStore

Parameters:

matcher - the matcher with which to compare trigger groups

Throws:

org.quartz.JobPersistenceException

getJobGroupNames

public List<String> getJobGroupNames()
                              throws org.quartz.JobPersistenceException

Get the names of all of the Job groups.

If there are no known group names, the result should be a zero-length array (not null).

Specified by:

getJobGroupNames in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getTriggerGroupNames

public List<String> getTriggerGroupNames()
                                  throws org.quartz.JobPersistenceException

Get the names of all of the Trigger groups.

If there are no known group names, the result should be a zero-length array (not null).

Specified by:

getTriggerGroupNames in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getCalendarNames

public List<String> getCalendarNames()
                              throws org.quartz.JobPersistenceException

Get the names of all of the Calendar s in the JobStore.

If there are no Calendars in the given group name, the result should be a zero-length array (not null).

Specified by:

getCalendarNames in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

getTriggersForJob

public List<org.quartz.spi.OperableTrigger> getTriggersForJob(org.quartz.JobKey jobKey)
                                                       throws org.quartz.JobPersistenceException

Get all of the Triggers that are associated to the given Job.

If there are no matches, a zero-length array should be returned.

Specified by:

getTriggersForJob in interface org.quartz.spi.JobStore

Parameters:

jobKey - the key of the job for which to retrieve triggers

Throws:

org.quartz.JobPersistenceException

getTriggerState

public org.quartz.Trigger.TriggerState getTriggerState(org.quartz.TriggerKey triggerKey)
                                                throws org.quartz.JobPersistenceException

Get the current state of the identified Trigger.

Specified by:

getTriggerState in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key of the trigger for which to retrieve state

Throws:

org.quartz.JobPersistenceException

See Also:

Trigger.TriggerState

pauseTrigger

public void pauseTrigger(org.quartz.TriggerKey triggerKey)
                  throws org.quartz.JobPersistenceException

Pause the Trigger with the given key.

Specified by:

pauseTrigger in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key for the trigger to be paused

Throws:

org.quartz.JobPersistenceException

See Also:

resumeTrigger(org.quartz.TriggerKey)

pauseTriggers

public Collection<String> pauseTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher)
                                 throws org.quartz.JobPersistenceException

Pause all of the Triggers in the given group.

The JobStore should "remember" that the group is paused, and impose the pause on any new triggers that are added to the group while the group is paused.

Specified by:

pauseTriggers in interface org.quartz.spi.JobStore

Parameters:

matcher - a trigger group matcher

Throws:

org.quartz.JobPersistenceException

pauseJob

public void pauseJob(org.quartz.JobKey jobKey)
              throws org.quartz.JobPersistenceException

Pause the Job with the given name - by pausing all of its current Triggers.

Specified by:

pauseJob in interface org.quartz.spi.JobStore

Parameters:

jobKey - the key of the job to be paused

Throws:

org.quartz.JobPersistenceException

See Also:

resumeJob(org.quartz.JobKey)

pauseJobs

public Collection<String> pauseJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher)
                             throws org.quartz.JobPersistenceException

Pause all of the Jobs in the given group - by pausing all of their Triggers.

The JobStore should "remember" that the group is paused, and impose the pause on any new jobs that are added to the group while the group is paused.

Specified by:

pauseJobs in interface org.quartz.spi.JobStore

Parameters:

groupMatcher - the mather which will determine which job group should be paused

Throws:

org.quartz.JobPersistenceException

See Also:

resumeJobs(org.quartz.impl.matchers.GroupMatcher)

resumeTrigger

public void resumeTrigger(org.quartz.TriggerKey triggerKey)
                   throws org.quartz.JobPersistenceException

Resume (un-pause) the Trigger with the given key.

If the Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeTrigger in interface org.quartz.spi.JobStore

Parameters:

triggerKey - the key of the trigger to be resumed

Throws:

org.quartz.JobPersistenceException

See Also:

pauseTrigger(org.quartz.TriggerKey)

resumeTriggers

public Collection<String> resumeTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher)
                                  throws org.quartz.JobPersistenceException

Resume (un-pause) all of the Triggers in the given group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeTriggers in interface org.quartz.spi.JobStore

Parameters:

matcher - a trigger group matcher

Throws:

org.quartz.JobPersistenceException

See Also:

pauseTriggers(org.quartz.impl.matchers.GroupMatcher)

getPausedTriggerGroups

public Set<String> getPausedTriggerGroups()
                                   throws org.quartz.JobPersistenceException

Specified by:

getPausedTriggerGroups in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

resumeJob

public void resumeJob(org.quartz.JobKey jobKey)
               throws org.quartz.JobPersistenceException

Resume (un-pause) the Job with the given key.

If any of the Job'sTrigger s missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeJob in interface org.quartz.spi.JobStore

Parameters:

jobKey - the key of the job to be resumed

Throws:

org.quartz.JobPersistenceException

See Also:

pauseJob(org.quartz.JobKey)

resumeJobs

public Collection<String> resumeJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher)
                              throws org.quartz.JobPersistenceException

Resume (un-pause) all of the Jobs in the given group.

If any of the Job s had Trigger s that missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeJobs in interface org.quartz.spi.JobStore

Parameters:

matcher - the matcher for job group name comparison

Throws:

org.quartz.JobPersistenceException

See Also:

pauseJobs(org.quartz.impl.matchers.GroupMatcher)

pauseAll

public void pauseAll()
              throws org.quartz.JobPersistenceException

Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.

When resumeAll() is called (to un-pause), trigger misfire instructions WILL be applied.

Specified by:

pauseAll in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

See Also:

resumeAll(), pauseTriggers(org.quartz.impl.matchers.GroupMatcher)

resumeAll

public void resumeAll()
               throws org.quartz.JobPersistenceException

Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeAll in interface org.quartz.spi.JobStore

Throws:

org.quartz.JobPersistenceException

See Also:

pauseAll()

acquireNextTriggers

public List<org.quartz.spi.OperableTrigger> acquireNextTriggers(long noLaterThan,
                                                                int maxCount,
                                                                long timeWindow)
                                                         throws org.quartz.JobPersistenceException

Get a handle to the next trigger to be fired, and mark it as 'reserved' by the calling scheduler.

Specified by:

acquireNextTriggers in interface org.quartz.spi.JobStore

Parameters:

noLaterThan - If > 0, the JobStore should only return a Trigger that will fire no later than the time represented in this value as milliseconds.

maxCount - the maximum number of triggers to return

timeWindow - @see #releaseAcquiredTrigger(Trigger)

Throws:

org.quartz.JobPersistenceException

releaseAcquiredTrigger

public void releaseAcquiredTrigger(org.quartz.spi.OperableTrigger trigger)

Inform the JobStore that the scheduler no longer plans to fire the given Trigger, that it had previously acquired (reserved).

Specified by:

releaseAcquiredTrigger in interface org.quartz.spi.JobStore

Parameters:

trigger - the trigger to be released

triggersFired

public List<org.quartz.spi.TriggerFiredResult> triggersFired(List<org.quartz.spi.OperableTrigger> triggers)
                                                      throws org.quartz.JobPersistenceException

Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Specified by:

triggersFired in interface org.quartz.spi.JobStore

Parameters:

triggers - a list of triggers which are being fired by the scheduler

Returns:

may return null if all the triggers or their calendars no longer exist, or if the trigger was not successfully put into the 'executing' state. Preference is to return an empty list if none of the triggers could be fired.

Throws:

org.quartz.JobPersistenceException

triggeredJobComplete

public void triggeredJobComplete(org.quartz.spi.OperableTrigger trigger,
                                 org.quartz.JobDetail jobDetail,
                                 org.quartz.Trigger.CompletedExecutionInstruction triggerInstCode)

Inform the JobStore that the scheduler has completed the firing of the given Trigger (and the execution of its associated Job completed, threw an exception, or was vetoed), and that the JobDataMap in the given JobDetail should be updated if the Job is stateful.

Specified by:

triggeredJobComplete in interface org.quartz.spi.JobStore

Parameters:

trigger - the completetd trigger

jobDetail - the completed job

triggerInstCode - the trigger completion code

setLockTimeout

public void setLockTimeout(int lockTimeout)

setLockTimeout

public void setLockTimeout(String lockTimeout)

setHost

public void setHost(String host)

setPort

public void setPort(int port)

setPort

public void setPort(String port)

setDatabase

public void setDatabase(int database)

setDatabase

public void setDatabase(String database)

setSsl

public void setSsl(boolean ssl)

setSsl

public void setSsl(String ssl)

setKeyPrefix

public void setKeyPrefix(String keyPrefix)

setKeyDelimiter

public void setKeyDelimiter(String keyDelimiter)

setRedisCluster

public void setRedisCluster(boolean clustered)

setRedisSentinel

public void setRedisSentinel(boolean sentinel)

setMasterGroupName

public void setMasterGroupName(String masterGroupName)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

setInstanceId

public void setInstanceId(String schedInstId)

Inform the JobStore of the Scheduler instance's Id, prior to initialize being invoked.

Specified by:

setInstanceId in interface org.quartz.spi.JobStore

Parameters:

schedInstId - the instanceid for the current scheduler

Since:

1.7

setInstanceName

public void setInstanceName(String schedName)

Inform the JobStore of the Scheduler instance's name, prior to initialize being invoked.

Specified by:

setInstanceName in interface org.quartz.spi.JobStore

Parameters:

schedName - the name of the current scheduler

Since:

1.7

setThreadPoolSize

public void setThreadPoolSize(int poolSize)

Tells the JobStore the pool size used to execute jobs

Specified by:

setThreadPoolSize in interface org.quartz.spi.JobStore

Parameters:

poolSize - amount of threads allocated for job execution

Since:

2.0