net.joelinn.quartz.jobstore

Class RedisStorage

java.lang.Object

net.joelinn.quartz.jobstore.AbstractRedisStorage<redis.clients.jedis.Jedis>

net.joelinn.quartz.jobstore.RedisStorage

public class RedisStorage
extends AbstractRedisStorage<redis.clients.jedis.Jedis>

Joe Linn 8/22/2015

Field Summary

Fields inherited from class net.joelinn.quartz.jobstore.AbstractRedisStorage

CALENDAR_CLASS, CALENDAR_JSON, lockTimeout, lockValue, mapper, misfireThreshold, redisSchema, schedulerInstanceId, signaler, TRIGGER_CLASS, TRIGGER_LOCK_TIMEOUT, TRIGGER_NEXT_FIRE_TIME

Constructor Summary

Constructors

Constructor and Description
RedisStorage(RedisJobStoreSchema redisSchema, com.fasterxml.jackson.databind.ObjectMapper mapper, org.quartz.spi.SchedulerSignaler signaler, String schedulerInstanceId, int lockTimeout)

Method Summary

Modifier and Type	Method and Description
Set<org.quartz.JobKey>	getJobKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher, redis.clients.jedis.Jedis jedis) Get the keys of all of the Job s that have the given group name.
Set<org.quartz.TriggerKey>	getTriggerKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher, redis.clients.jedis.Jedis jedis) Get the names of all of the Trigger s that have the given group name.
org.quartz.Trigger.TriggerState	getTriggerState(org.quartz.TriggerKey triggerKey, redis.clients.jedis.Jedis jedis) Get the current state of the identified Trigger.
Collection<String>	pauseJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher, redis.clients.jedis.Jedis jedis) Pause all of the Jobs in the given group - by pausing all of their Triggers.
void	pauseTrigger(org.quartz.TriggerKey triggerKey, redis.clients.jedis.Jedis jedis) Pause the trigger with the given key
Collection<String>	pauseTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher, redis.clients.jedis.Jedis jedis) Pause all of the Triggers in the given group.
boolean	removeCalendar(String calendarName, redis.clients.jedis.Jedis jedis) Remove (delete) the Calendar with the given name.
boolean	removeJob(org.quartz.JobKey jobKey, redis.clients.jedis.Jedis jedis) Remove the given job from Redis
protected boolean	removeTrigger(org.quartz.TriggerKey triggerKey, boolean removeNonDurableJob, redis.clients.jedis.Jedis jedis) Remove (delete) the Trigger with the given key.
Collection<String>	resumeJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher, redis.clients.jedis.Jedis jedis) Resume (un-pause) all of the Jobs in the given group.
void	resumeTrigger(org.quartz.TriggerKey triggerKey, redis.clients.jedis.Jedis jedis) Resume (un-pause) a Trigger
Collection<String>	resumeTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher, redis.clients.jedis.Jedis jedis) Resume (un-pause) all of the Triggers in the given group.
void	storeCalendar(String name, org.quartz.Calendar calendar, boolean replaceExisting, boolean updateTriggers, redis.clients.jedis.Jedis jedis) Store a Calendar
void	storeJob(org.quartz.JobDetail jobDetail, boolean replaceExisting, redis.clients.jedis.Jedis jedis) Store a job in Redis
void	storeTrigger(org.quartz.spi.OperableTrigger trigger, boolean replaceExisting, redis.clients.jedis.Jedis jedis) Store a trigger in redis
void	triggeredJobComplete(org.quartz.spi.OperableTrigger trigger, org.quartz.JobDetail jobDetail, org.quartz.Trigger.CompletedExecutionInstruction triggerInstCode, redis.clients.jedis.Jedis jedis) 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, redis.clients.jedis.Jedis jedis) Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).
boolean	unsetTriggerState(String triggerHashKey, redis.clients.jedis.Jedis jedis) Unsets the state of the given trigger key by removing the trigger from all trigger state sets.

Methods inherited from class net.joelinn.quartz.jobstore.AbstractRedisStorage

acquireNextTriggers, applyMisfire, checkExists, checkExists, clearAllSchedulingData, getCalendarNames, getJobGroupNames, getLastTriggersReleaseTime, getNumberOfCalendars, getNumberOfJobs, getNumberOfTriggers, getPausedTriggerGroups, getStringDataMap, getTriggerGroupNames, getTriggersForJob, isJobConcurrentExecutionDisallowed, isNullOrEmpty, isPersistJobDataAfterExecution, lock, lockTrigger, pauseAll, pauseJob, randomInt, releaseAcquiredTrigger, releaseOrphanedTriggers, releaseTriggersCron, removeTrigger, replaceTrigger, resumeAll, resumeJob, retrieveCalendar, retrieveJob, retrieveTrigger, setMisfireThreshold, settLastTriggerReleaseTime, setTriggerState, unlock, waitForLock

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisStorage

public RedisStorage(RedisJobStoreSchema redisSchema,
                    com.fasterxml.jackson.databind.ObjectMapper mapper,
                    org.quartz.spi.SchedulerSignaler signaler,
                    String schedulerInstanceId,
                    int lockTimeout)

Method Detail

removeJob

public boolean removeJob(org.quartz.JobKey jobKey,
                         redis.clients.jedis.Jedis jedis)
                  throws org.quartz.JobPersistenceException

Remove the given job from Redis

Specified by:

removeJob in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

jobKey - the job to be removed

jedis - a thread-safe Redis connection

Returns:

true if the job was removed; false if it did not exist

Throws:

org.quartz.JobPersistenceException

removeTrigger

protected boolean removeTrigger(org.quartz.TriggerKey triggerKey,
                                boolean removeNonDurableJob,
                                redis.clients.jedis.Jedis jedis)
                         throws org.quartz.JobPersistenceException,
                                ClassNotFoundException

Remove (delete) the Trigger with the given key.

Specified by:

removeTrigger in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggerKey - the key of the trigger to be removed

removeNonDurableJob - if true, the job associated with the given trigger will be removed if it is non-durable and has no other triggers

jedis - a thread-safe Redis connection

Returns:

true if the trigger was found and removed

Throws:

org.quartz.JobPersistenceException

ClassNotFoundException

storeJob

public void storeJob(org.quartz.JobDetail jobDetail,
                     boolean replaceExisting,
                     redis.clients.jedis.Jedis jedis)
              throws org.quartz.ObjectAlreadyExistsException

Store a job in Redis

Specified by:

storeJob in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

jobDetail - the JobDetail object to be stored

replaceExisting - if true, any existing job with the same group and name as the given job will be overwritten

jedis - a thread-safe Redis connection

Throws:

org.quartz.ObjectAlreadyExistsException

storeTrigger

public void storeTrigger(org.quartz.spi.OperableTrigger trigger,
                         boolean replaceExisting,
                         redis.clients.jedis.Jedis jedis)
                  throws org.quartz.JobPersistenceException

Store a trigger in redis

Specified by:

storeTrigger in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

trigger - the trigger to be stored

replaceExisting - true if an existing trigger with the same identity should be replaced

jedis - a thread-safe Redis connection

Throws:

org.quartz.JobPersistenceException

org.quartz.ObjectAlreadyExistsException

unsetTriggerState

public boolean unsetTriggerState(String triggerHashKey,
                                 redis.clients.jedis.Jedis jedis)
                          throws org.quartz.JobPersistenceException

Unsets the state of the given trigger key by removing the trigger from all trigger state sets.

Specified by:

unsetTriggerState in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggerHashKey - the redis key of the desired trigger hash

jedis - a thread-safe Redis connection

Returns:

true if the trigger was removed, false if the trigger was stateless

Throws:

org.quartz.JobPersistenceException - if the unset operation failed

storeCalendar

public void storeCalendar(String name,
                          org.quartz.Calendar calendar,
                          boolean replaceExisting,
                          boolean updateTriggers,
                          redis.clients.jedis.Jedis jedis)
                   throws org.quartz.JobPersistenceException

Store a Calendar

Specified by:

storeCalendar in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

name - the name of the calendar

calendar - the calendar object to be stored

replaceExisting - if true, any existing calendar with the same name will be overwritten

updateTriggers - if true, any existing triggers associated with the calendar will be updated

jedis - a thread-safe Redis connection

Throws:

org.quartz.JobPersistenceException

removeCalendar

public boolean removeCalendar(String calendarName,
                              redis.clients.jedis.Jedis jedis)
                       throws org.quartz.JobPersistenceException

Remove (delete) the Calendar with the given name.

Specified by:

removeCalendar in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

calendarName - the name of the calendar to be removed

jedis - a thread-safe Redis connection

Returns:

true if a calendar with the given name was found and removed

Throws:

org.quartz.JobPersistenceException

getJobKeys

public Set<org.quartz.JobKey> getJobKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher,
                                         redis.clients.jedis.Jedis jedis)

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

Specified by:

getJobKeys in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

matcher - the matcher with which to compare group names

jedis - a thread-safe Redis connection

Returns:

the set of all JobKeys which have the given group name

getTriggerKeys

public Set<org.quartz.TriggerKey> getTriggerKeys(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher,
                                                 redis.clients.jedis.Jedis jedis)

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

Specified by:

getTriggerKeys in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

matcher - the matcher with which to compare group names

jedis - a thread-safe Redis connection

Returns:

the set of all TriggerKeys which have the given group name

getTriggerState

public org.quartz.Trigger.TriggerState getTriggerState(org.quartz.TriggerKey triggerKey,
                                                       redis.clients.jedis.Jedis jedis)

Get the current state of the identified Trigger.

Specified by:

getTriggerState in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggerKey - the key of the desired trigger

jedis - a thread-safe Redis connection

Returns:

the state of the trigger

pauseTrigger

public void pauseTrigger(org.quartz.TriggerKey triggerKey,
                         redis.clients.jedis.Jedis jedis)
                  throws org.quartz.JobPersistenceException

Pause the trigger with the given key

Specified by:

pauseTrigger in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggerKey - the key of the trigger to be paused

jedis - a thread-safe Redis connection

Throws:

org.quartz.JobPersistenceException - if the desired trigger does not exist

pauseTriggers

public Collection<String> pauseTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher,
                                        redis.clients.jedis.Jedis jedis)
                                 throws org.quartz.JobPersistenceException

Pause all of the Triggers in the given group.

Specified by:

pauseTriggers in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

matcher - matcher for the trigger groups to be paused

jedis - a thread-safe Redis connection

Returns:

a collection of names of trigger groups which were matched and paused

Throws:

org.quartz.JobPersistenceException

pauseJobs

public Collection<String> pauseJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> groupMatcher,
                                    redis.clients.jedis.Jedis jedis)
                             throws org.quartz.JobPersistenceException

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

Specified by:

pauseJobs in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

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

jedis - a thread-safe Redis connection

Returns:

a collection of names of job groups which have been paused

Throws:

org.quartz.JobPersistenceException

resumeTrigger

public void resumeTrigger(org.quartz.TriggerKey triggerKey,
                          redis.clients.jedis.Jedis jedis)
                   throws org.quartz.JobPersistenceException

Resume (un-pause) a Trigger

Specified by:

resumeTrigger in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggerKey - the key of the trigger to be resumed

jedis - a thread-safe Redis connection

Throws:

org.quartz.JobPersistenceException

resumeTriggers

public Collection<String> resumeTriggers(org.quartz.impl.matchers.GroupMatcher<org.quartz.TriggerKey> matcher,
                                         redis.clients.jedis.Jedis jedis)
                                  throws org.quartz.JobPersistenceException

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

Specified by:

resumeTriggers in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

matcher - matcher for the trigger groups to be resumed

jedis - a thread-safe Redis connection

Returns:

the names of trigger groups which were resumed

Throws:

org.quartz.JobPersistenceException

resumeJobs

public Collection<String> resumeJobs(org.quartz.impl.matchers.GroupMatcher<org.quartz.JobKey> matcher,
                                     redis.clients.jedis.Jedis jedis)
                              throws org.quartz.JobPersistenceException

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

Specified by:

resumeJobs in class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

matcher - the matcher with which to compare job group names

jedis - a thread-safe Redis connection

Returns:

the set of job groups which were matched and resumed

Throws:

org.quartz.JobPersistenceException

triggersFired

public List<org.quartz.spi.TriggerFiredResult> triggersFired(List<org.quartz.spi.OperableTrigger> triggers,
                                                             redis.clients.jedis.Jedis jedis)
                                                      throws org.quartz.JobPersistenceException,
                                                             ClassNotFoundException

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 class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

triggers - a list of triggers

jedis - a thread-safe Redis connection

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

ClassNotFoundException

triggeredJobComplete

public void triggeredJobComplete(org.quartz.spi.OperableTrigger trigger,
                                 org.quartz.JobDetail jobDetail,
                                 org.quartz.Trigger.CompletedExecutionInstruction triggerInstCode,
                                 redis.clients.jedis.Jedis jedis)
                          throws org.quartz.JobPersistenceException,
                                 ClassNotFoundException

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 class AbstractRedisStorage<redis.clients.jedis.Jedis>

Parameters:

trigger - the trigger which was completed

jobDetail - the job which was completed

triggerInstCode - the status of the completed job

jedis - a thread-safe Redis connection

Throws:

org.quartz.JobPersistenceException

ClassNotFoundException