Package org.quartz.core

Interface JobStore

All Known Implementing Classes:

RAMJobStore

public interface JobStore

The interface to be implemented by classes that want to provide a Job and Trigger 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

Method Summary

Modifier and Type	Method	Description
List<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.
Set<String>	getJobKeys()	Get the keys of all of the Job s
List<Trigger>	getTriggersForJob(String jobKey)	Get all of the Triggers that are associated to the given Job.
void	initialize(SchedulerSignaler signaler)	Called by the QuartzScheduler before the JobStore is used, in order to give the it a chance to initialize.
void	releaseAcquiredTrigger(OperableTrigger trigger)	Inform the JobStore that the scheduler no longer plans to fire the given Trigger, that it had previously acquired (reserved).
boolean	removeJob(String jobKey)	Remove (delete) the Job with the given key, and any Trigger s that reference it.
boolean	removeTrigger(String triggerKey)	Remove (delete) the Trigger with the given key.
boolean	replaceTrigger(String triggerKey, OperableTrigger newTrigger)	Remove (delete) the Trigger with the given key, and store the new given one - which must be associated with the same job.
Calendar	retrieveCalendar(String calName)	Retrieve the given Trigger.
JobDetail	retrieveJob(String jobKey)	Retrieve the JobDetail for the given Job.
OperableTrigger	retrieveTrigger(String triggerKey)	Retrieve the given Trigger.
void	schedulerStarted()	Called by the QuartzScheduler to inform the JobStore that the scheduler has started.
void	setThreadPoolSize(int poolSize)	Tells the JobStore the pool size used to execute jobs
void	storeJob(JobDetail newJob, boolean replaceExisting)	Store the given JobDetail.
void	storeJobAndTrigger(JobDetail newJob, OperableTrigger newTrigger)	Store the given JobDetail and Trigger.
void	storeTrigger(OperableTrigger newTrigger, boolean replaceExisting)	Store the given Trigger.
void	triggeredJobComplete(OperableTrigger trigger, JobDetail jobDetail, 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<TriggerFiredResult>	triggersFired(List<OperableTrigger> triggers)	Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Method Details

initialize

void initialize(SchedulerSignaler 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

storeJobAndTrigger

void storeJobAndTrigger(JobDetail newJob,
 OperableTrigger newTrigger)
                 throws ObjectAlreadyExistsException,
JobPersistenceException

Store the given JobDetail and Trigger.

Parameters:

newJob - The JobDetail to be stored.

newTrigger - The Trigger to be stored.

Throws:

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

JobPersistenceException

storeJob

void storeJob(JobDetail newJob,
 boolean replaceExisting)
       throws ObjectAlreadyExistsException,
JobPersistenceException

Store the given JobDetail.

Parameters:

newJob - The JobDetail to be stored.

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

Throws:

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

JobPersistenceException

removeJob

boolean removeJob(String jobKey)
           throws 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.

Returns:

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

Throws:

JobPersistenceException

retrieveJob

JobDetail retrieveJob(String jobKey)
               throws JobPersistenceException

Retrieve the JobDetail for the given Job.

Returns:

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

Throws:

JobPersistenceException

storeTrigger

void storeTrigger(OperableTrigger newTrigger,
 boolean replaceExisting)
           throws ObjectAlreadyExistsException,
JobPersistenceException

Store the given Trigger.

Parameters:

newTrigger - The Trigger to be stored.

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

Throws:

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

JobPersistenceException

removeTrigger

boolean removeTrigger(String triggerKey)
               throws 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.

Returns:

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

Throws:

JobPersistenceException

replaceTrigger

boolean replaceTrigger(String triggerKey,
 OperableTrigger newTrigger)
                throws JobPersistenceException

Remove (delete) the Trigger 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 was found and removed from the store.

Throws:

JobPersistenceException

retrieveTrigger

OperableTrigger retrieveTrigger(String triggerKey)
                         throws JobPersistenceException

Retrieve the given Trigger.

Returns:

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

Throws:

JobPersistenceException

retrieveCalendar

Calendar retrieveCalendar(String calName)
                   throws JobPersistenceException

Retrieve the given Trigger.

Parameters:

calName - The name of the Calendar to be retrieved.

Returns:

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

Throws:

JobPersistenceException

getTriggersForJob

List<Trigger> getTriggersForJob(String 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

getJobKeys

Set<String> getJobKeys()
                throws JobPersistenceException

Get the keys of all of the Job s

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

Throws:

JobPersistenceException

acquireNextTriggers

List<OperableTrigger> 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

releaseAcquiredTrigger

void releaseAcquiredTrigger(OperableTrigger trigger)
                     throws JobPersistenceException

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

Throws:

JobPersistenceException

triggersFired

List<TriggerFiredResult> triggersFired(List<OperableTrigger> 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(OperableTrigger trigger,
 JobDetail jobDetail,
 Trigger.CompletedExecutionInstruction triggerInstCode)
                   throws JobPersistenceException

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.

Throws:

JobPersistenceException

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