com.helger.quartz.spi

Interface IJobStore

All Known Implementing Classes:

RAMJobStore

public interface IJobStore

The interface to be implemented by classes that want to provide a IJob and ITrigger storage mechanism for the QuartzScheduler's use.

Storage of Job s and Trigger s should be keyed on the combination of their name and group for uniqueness.

Author:

James House, Eric Mueller

See Also:

QuartzScheduler, ITrigger, IJob, IJobDetail, JobDataMap, ICalendar

Method Summary

Modifier and Type	Method and Description
com.helger.commons.collection.impl.ICommonsList<IOperableTrigger>	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(JobKey jobKey) Determine whether a job with the given identifier already exists within the scheduler.
boolean	checkExists(TriggerKey triggerKey) Determine whether a ITrigger with the given identifier already exists within the scheduler.
void	clearAllSchedulingData() Clear (delete!)
com.helger.commons.collection.impl.ICommonsList<String>	getCalendarNames() Get the names of all of the ICalendar 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.
com.helger.commons.collection.impl.ICommonsList<String>	getJobGroupNames() Get the names of all of the IJob groups.
com.helger.commons.collection.impl.ICommonsSet<JobKey>	getJobKeys(GroupMatcher<JobKey> matcher) Get the keys of all of the IJob s that have the given group name.
int	getNumberOfCalendars() Get the number of ICalendar s that are stored in the JobsStore.
int	getNumberOfJobs() Get the number of IJob s that are stored in the JobsStore.
int	getNumberOfTriggers() Get the number of ITrigger s that are stored in the JobsStore.
com.helger.commons.collection.impl.ICommonsSet<String>	getPausedTriggerGroups()
com.helger.commons.collection.impl.ICommonsList<String>	getTriggerGroupNames() Get the names of all of the ITrigger groups.
com.helger.commons.collection.impl.ICommonsSet<TriggerKey>	getTriggerKeys(GroupMatcher<TriggerKey> matcher) Get the names of all of the ITrigger s that have the given group name.
com.helger.commons.collection.impl.ICommonsList<IOperableTrigger>	getTriggersForJob(JobKey jobKey) Get all of the Triggers that are associated to the given Job.
ITrigger.ETriggerState	getTriggerState(TriggerKey triggerKey) Get the current state of the identified ITrigger.
void	initialize(IClassLoadHelper loadHelper, ISchedulerSignaler 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 clustered.
void	pauseAll() Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.
void	pauseJob(JobKey jobKey) Pause the IJob with the given name - by pausing all of its current Triggers.
com.helger.commons.collection.impl.ICommonsCollection<String>	pauseJobs(GroupMatcher<JobKey> groupMatcher) Pause all of the IJobs in the given group - by pausing all of their Triggers.
void	pauseTrigger(TriggerKey triggerKey) Pause the ITrigger with the given key.
com.helger.commons.collection.impl.ICommonsCollection<String>	pauseTriggers(GroupMatcher<TriggerKey> matcher) Pause all of the ITriggers in the given group.
void	releaseAcquiredTrigger(IOperableTrigger 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 ICalendar with the given name.
boolean	removeJob(JobKey jobKey) Remove (delete) the IJob with the given key, and any ITrigger s that reference it.
boolean	removeJobs(List<JobKey> jobKeys)
boolean	removeTrigger(TriggerKey triggerKey) Remove (delete) the ITrigger with the given key.
boolean	removeTriggers(List<TriggerKey> triggerKeys)
boolean	replaceTrigger(TriggerKey triggerKey, IOperableTrigger newTrigger) Remove (delete) the ITrigger 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(JobKey jobKey) Resume (un-pause) the IJob with the given key.
com.helger.commons.collection.impl.ICommonsCollection<String>	resumeJobs(GroupMatcher<JobKey> matcher) Resume (un-pause) all of the IJobs in the given group.
void	resumeTrigger(TriggerKey triggerKey) Resume (un-pause) the ITrigger with the given key.
com.helger.commons.collection.impl.ICommonsCollection<String>	resumeTriggers(GroupMatcher<TriggerKey> matcher) Resume (un-pause) all of the ITriggers in the given group.
ICalendar	retrieveCalendar(String calName) Retrieve the given ITrigger.
IJobDetail	retrieveJob(JobKey jobKey) Retrieve the IJobDetail for the given IJob.
IOperableTrigger	retrieveTrigger(TriggerKey triggerKey) Retrieve the given ITrigger.
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	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.
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, ICalendar calendar, boolean replaceExisting, boolean updateTriggers) Store the given ICalendar.
void	storeJob(IJobDetail newJob, boolean replaceExisting) Store the given IJobDetail.
void	storeJobAndTrigger(IJobDetail newJob, IOperableTrigger newTrigger) Store the given IJobDetail and ITrigger.
void	storeJobsAndTriggers(Map<IJobDetail,Set<? extends ITrigger>> triggersAndJobs, boolean replace)
void	storeTrigger(IOperableTrigger newTrigger, boolean replaceExisting) Store the given ITrigger.
boolean	supportsPersistence()
void	triggeredJobComplete(IOperableTrigger trigger, IJobDetail jobDetail, ITrigger.ECompletedExecutionInstruction 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.
com.helger.commons.collection.impl.ICommonsList<TriggerFiredResult>	triggersFired(List<IOperableTrigger> triggers) Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Method Detail

initialize

void initialize(IClassLoadHelper loadHelper,
                ISchedulerSignaler signaler)
         throws SchedulerConfigException

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

Throws:

SchedulerConfigException

schedulerStarted

void schedulerStarted()
               throws SchedulerException

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

Throws:

SchedulerException

schedulerPaused

void schedulerPaused()

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

schedulerResumed

void schedulerResumed()

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

shutdown

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.

supportsPersistence

boolean supportsPersistence()

getEstimatedTimeToReleaseAndAcquireTrigger

long getEstimatedTimeToReleaseAndAcquireTrigger()

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

isClustered

boolean isClustered()

Whether or not the JobStore implementation is clustered.

storeJobAndTrigger

void storeJobAndTrigger(IJobDetail newJob,
                        IOperableTrigger newTrigger)
                 throws JobPersistenceException

Store the given IJobDetail and ITrigger.

Parameters:

newJob - The JobDetail to be stored.

newTrigger - The Trigger to be stored.

Throws:

JobPersistenceException - if a Job with the same name/group already exists.

storeJob

void storeJob(IJobDetail newJob,
              boolean replaceExisting)
       throws JobPersistenceException

Store the given IJobDetail.

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:

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

storeJobsAndTriggers

void storeJobsAndTriggers(Map<IJobDetail,Set<? extends ITrigger>> triggersAndJobs,
                          boolean replace)
                   throws JobPersistenceException

Throws:

JobPersistenceException

removeJob

boolean removeJob(JobKey jobKey)
           throws JobPersistenceException

Remove (delete) the IJob with the given key, and any ITrigger 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.

Returns:

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

Throws:

JobPersistenceException

removeJobs

boolean removeJobs(List<JobKey> jobKeys)
            throws JobPersistenceException

Throws:

JobPersistenceException

retrieveJob

IJobDetail retrieveJob(JobKey jobKey)
                throws JobPersistenceException

Retrieve the IJobDetail for the given IJob.

Returns:

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

Throws:

JobPersistenceException

storeTrigger

void storeTrigger(IOperableTrigger newTrigger,
                  boolean replaceExisting)
           throws JobPersistenceException

Store the given ITrigger.

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:

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

See Also:

pauseTriggers(com.helger.quartz.impl.matchers.GroupMatcher)

removeTrigger

boolean removeTrigger(TriggerKey triggerKey)
               throws JobPersistenceException

Remove (delete) the ITrigger 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.

Returns:

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

Throws:

JobPersistenceException

removeTriggers

boolean removeTriggers(List<TriggerKey> triggerKeys)
                throws JobPersistenceException

Throws:

JobPersistenceException

replaceTrigger

boolean replaceTrigger(TriggerKey triggerKey,
                       IOperableTrigger newTrigger)
                throws JobPersistenceException

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

Parameters:

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:

JobPersistenceException

retrieveTrigger

IOperableTrigger retrieveTrigger(TriggerKey triggerKey)
                          throws JobPersistenceException

Retrieve the given ITrigger.

Returns:

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

Throws:

JobPersistenceException

checkExists

boolean checkExists(JobKey jobKey)
             throws JobPersistenceException

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

Parameters:

jobKey - the identifier to check for

Returns:

true if a Job exists with the given identifier

Throws:

JobPersistenceException

checkExists

boolean checkExists(TriggerKey triggerKey)
             throws JobPersistenceException

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

Parameters:

triggerKey - the identifier to check for

Returns:

true if a Trigger exists with the given identifier

Throws:

JobPersistenceException

clearAllSchedulingData

void clearAllSchedulingData()
                     throws JobPersistenceException

Clear (delete!) all scheduling data - all jobs, ITriggers and ICalendars.

Throws:

JobPersistenceException

storeCalendar

void storeCalendar(String name,
                   ICalendar calendar,
                   boolean replaceExisting,
                   boolean updateTriggers)
            throws JobPersistenceException

Store the given ICalendar.

Parameters:

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:

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

removeCalendar

boolean removeCalendar(String calName)
                throws JobPersistenceException

Remove (delete) the ICalendar with the given name.

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

*

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:

JobPersistenceException

retrieveCalendar

ICalendar retrieveCalendar(String calName)
                    throws JobPersistenceException

Retrieve the given ITrigger.

Parameters:

calName - The name of the Calendar to be retrieved.

Returns:

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

Throws:

JobPersistenceException

getNumberOfJobs

int getNumberOfJobs()
             throws JobPersistenceException

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

Throws:

JobPersistenceException

getNumberOfTriggers

int getNumberOfTriggers()
                 throws JobPersistenceException

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

Throws:

JobPersistenceException

getNumberOfCalendars

int getNumberOfCalendars()
                  throws JobPersistenceException

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

Throws:

JobPersistenceException

getJobKeys

com.helger.commons.collection.impl.ICommonsSet<JobKey> getJobKeys(GroupMatcher<JobKey> matcher)
                                                           throws JobPersistenceException

Get the keys of all of the IJob 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).

Throws:

JobPersistenceException

getTriggerKeys

com.helger.commons.collection.impl.ICommonsSet<TriggerKey> getTriggerKeys(GroupMatcher<TriggerKey> matcher)
                                                                   throws JobPersistenceException

Get the names of all of the ITrigger 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).

Throws:

JobPersistenceException

getJobGroupNames

com.helger.commons.collection.impl.ICommonsList<String> getJobGroupNames()
                                                                  throws JobPersistenceException

Get the names of all of the IJob groups.

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

Throws:

JobPersistenceException

getTriggerGroupNames

com.helger.commons.collection.impl.ICommonsList<String> getTriggerGroupNames()
                                                                      throws JobPersistenceException

Get the names of all of the ITrigger groups.

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

Throws:

JobPersistenceException

getCalendarNames

com.helger.commons.collection.impl.ICommonsList<String> getCalendarNames()
                                                                  throws JobPersistenceException

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

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

Throws:

JobPersistenceException

getTriggersForJob

com.helger.commons.collection.impl.ICommonsList<IOperableTrigger> getTriggersForJob(JobKey jobKey)
                                                                             throws 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.

Throws:

JobPersistenceException

getTriggerState

ITrigger.ETriggerState getTriggerState(TriggerKey triggerKey)
                                throws JobPersistenceException

Get the current state of the identified ITrigger.

Throws:

JobPersistenceException

See Also:

ITrigger.ETriggerState

pauseTrigger

void pauseTrigger(TriggerKey triggerKey)
           throws JobPersistenceException

Pause the ITrigger with the given key.

Throws:

JobPersistenceException

See Also:

resumeTrigger(TriggerKey)

pauseTriggers

com.helger.commons.collection.impl.ICommonsCollection<String> pauseTriggers(GroupMatcher<TriggerKey> matcher)
                                                                     throws JobPersistenceException

Pause all of the ITriggers 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.

Throws:

JobPersistenceException

See Also:

resumeTriggers(GroupMatcher)

pauseJob

void pauseJob(JobKey jobKey)
       throws JobPersistenceException

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

Throws:

JobPersistenceException

See Also:

resumeJob(JobKey)

pauseJobs

com.helger.commons.collection.impl.ICommonsCollection<String> pauseJobs(GroupMatcher<JobKey> groupMatcher)
                                                                 throws JobPersistenceException

Pause all of the IJobs 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.

Throws:

JobPersistenceException

See Also:

resumeJobs(GroupMatcher)

resumeTrigger

void resumeTrigger(TriggerKey triggerKey)
            throws JobPersistenceException

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

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

Throws:

JobPersistenceException

See Also:

pauseTrigger(TriggerKey)

resumeTriggers

com.helger.commons.collection.impl.ICommonsCollection<String> resumeTriggers(GroupMatcher<TriggerKey> matcher)
                                                                      throws JobPersistenceException

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

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

Throws:

JobPersistenceException

See Also:

pauseTriggers(GroupMatcher)

getPausedTriggerGroups

com.helger.commons.collection.impl.ICommonsSet<String> getPausedTriggerGroups()
                                                                       throws JobPersistenceException

Throws:

JobPersistenceException

resumeJob

void resumeJob(JobKey jobKey)
        throws JobPersistenceException

Resume (un-pause) the IJob 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.

Throws:

JobPersistenceException

See Also:

pauseJob(JobKey)

resumeJobs

com.helger.commons.collection.impl.ICommonsCollection<String> resumeJobs(GroupMatcher<JobKey> matcher)
                                                                  throws JobPersistenceException

Resume (un-pause) all of the IJobs 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.

Throws:

JobPersistenceException

See Also:

pauseJobs(GroupMatcher)

pauseAll

void pauseAll()
       throws 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.

Throws:

JobPersistenceException

See Also:

resumeAll(), pauseTriggers(GroupMatcher)

resumeAll

void resumeAll()
        throws 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.

Throws:

JobPersistenceException

See Also:

pauseAll()

acquireNextTriggers

com.helger.commons.collection.impl.ICommonsList<IOperableTrigger> acquireNextTriggers(long noLaterThan,
                                                                                      int maxCount,
                                                                                      long timeWindow)
                                                                               throws JobPersistenceException

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

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.

Throws:

JobPersistenceException

See Also:

releaseAcquiredTrigger(IOperableTrigger)

releaseAcquiredTrigger

void releaseAcquiredTrigger(IOperableTrigger trigger)

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

triggersFired

com.helger.commons.collection.impl.ICommonsList<TriggerFiredResult> triggersFired(List<IOperableTrigger> triggers)
                                                                           throws JobPersistenceException

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

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:

JobPersistenceException

triggeredJobComplete

void triggeredJobComplete(IOperableTrigger trigger,
                          IJobDetail jobDetail,
                          ITrigger.ECompletedExecutionInstruction 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.

setInstanceId

void setInstanceId(String schedInstId)

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

Since:

1.7

setInstanceName

void setInstanceName(String schedName)

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

Since:

1.7

setThreadPoolSize

void setThreadPoolSize(int poolSize)

Tells the JobStore the pool size used to execute jobs

Parameters:

poolSize - amount of threads allocated for job execution

Since:

2.0