org.quartz

Class QuartzScheduler

java.lang.Object

org.quartz.QuartzScheduler

All Implemented Interfaces:

Scheduler

public class QuartzScheduler
extends Object
implements Scheduler

This is the heart of Quartz, an indirect implementation of the Scheduler interface, containing methods to schedule Jobs, register JobListener instances, etc.

Author:

James House

Constructor Summary

Constructors

Constructor and Description
QuartzScheduler(QuartzSchedulerResources quartzSchedulerResources) Create a QuartzScheduler with the given configuration properties.

Method Summary

Modifier and Type	Method and Description
void	addInternalSchedulerListener(SchedulerListener schedulerListener) Register the given SchedulerListener with the Scheduler's list of internal listeners.
void	addJob(JobDetail jobDetail) Add the given Job to the Scheduler - with no associated Trigger.
void	deleteJob(String jobKey) Delete the identified Job from the Scheduler - and any associated Triggers.
CascadingClassLoadHelper	getCascadingClassLoadHelper()
List<JobExecutionContext>	getCurrentlyExecutingJobs() Return a list of JobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance.
List<JobListener>	getInternalJobListeners() Get a List containing all of the JobListeners in the Scheduler's internal list.
List<SchedulerListener>	getInternalSchedulerListeners() Get a List containing all of the internal SchedulerListeners registered with the Scheduler.
List<TriggerListener>	getInternalTriggerListeners() Get a list containing all of the TriggerListeners in the Scheduler's internal list.
JobDetail	getJobDetail(String jobKey) Get the JobDetail for the Job instance with the given name and group.
JobFactory	getJobFactory()
Set<String>	getJobKeys() Get the names of all the Jobs in the matching groups.
Class	getJobStoreClass()
ListenerManager	getListenerManager() Clears (deletes!) all scheduling data - all Jobs, Triggers Calendars.
SchedulerSignaler	getSchedulerSignaler()
ThreadGroup	getSchedulerThreadGroup() Returns the name of the thread group for Quartz's main threads.
Class	getThreadPoolClass()
int	getThreadPoolSize()
Trigger	getTrigger(String triggerKey) Get the Trigger instance with the given name and group.
List<Trigger>	getTriggersOfJob(String jobKey) Get all Trigger s that are associated with the identified JobDetail.
void	initialize()
boolean	isInStandbyMode() Reports whether the Scheduler is paused.
boolean	isShutdown() Reports whether the Scheduler has been shutdown.
boolean	isShuttingDown()
boolean	isSignalOnSchedulingChange()
boolean	isStarted() Whether the scheduler has been started.
void	notifyJobListenersToBeExecuted(JobExecutionContext jec)
void	notifyJobListenersWasExecuted(JobExecutionContext jec, JobExecutionException je)
void	notifyJobListenersWasVetoed(JobExecutionContext jec)
void	notifyJobStoreJobComplete(OperableTrigger trigger, JobDetail detail, Trigger.CompletedExecutionInstruction instCode)
void	notifyJobStoreJobVetoed(OperableTrigger trigger, JobDetail detail, Trigger.CompletedExecutionInstruction instCode)
void	notifySchedulerListenersError(String msg, SchedulerException se)
void	notifySchedulerListenersFinalized(Trigger trigger)
void	notifySchedulerListenersJobDeleted(String jobKey)
void	notifyTriggerListenersComplete(JobExecutionContext jec, Trigger.CompletedExecutionInstruction instCode)
boolean	notifyTriggerListenersFired(JobExecutionContext jec)
void	notifyTriggerListenersMisfired(Trigger trigger)
boolean	removeInternalSchedulerListener(SchedulerListener schedulerListener) Remove the given SchedulerListener from the Scheduler's list of internal listeners.
Date	rescheduleJob(String triggerName, OperableTrigger newTrigger) Remove (delete) the OperableTrigger with the given key, and store the new given one - which must be associated with the same job (the new trigger must have the job name specified) - however, the new trigger need not have the same name as the old trigger.
Date	scheduleJob(JobDetail jobDetail, OperableTrigger trigger) Add the Job identified by the given JobDetail to the Scheduler, and associate the given Trigger with it.
Date	scheduleJob(OperableTrigger trigger) Schedule the given Trigger with the Job identified by the Trigger's settings.
void	setJobFactory(JobFactory factory) Set the JobFactory that will be responsible for producing instances of Job classes.
void	setSignalOnSchedulingChange(boolean signalOnSchedulingChange)
void	shutdown(boolean waitForJobsToComplete) Halts the QuartzScheduler's firing of Triggers, and cleans up all resources associated with the QuartzScheduler.
void	standby() Temporarily halts the QuartzScheduler's firing of Triggers.
void	start() Starts the QuartzScheduler's threads that fire Triggers.
void	startDelayed(int seconds) Calls {#start()} after the indicated number of seconds.
void	triggerJob(String jobKey, JobDataMap data) Trigger the identified Job (execute it now) - with a non-volatile trigger.
void	unscheduleJob(String triggerKey) Remove the indicated Trigger from the scheduler.

Methods inherited from class java.lang.Object

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

Constructor Detail

QuartzScheduler

public QuartzScheduler(QuartzSchedulerResources quartzSchedulerResources)
                throws SchedulerException

Create a QuartzScheduler with the given configuration properties.

Throws:

SchedulerException

See Also:

QuartzSchedulerResources

Method Detail

initialize

public void initialize()
                throws SchedulerException

Throws:

SchedulerException

getSchedulerSignaler

public SchedulerSignaler getSchedulerSignaler()

getSchedulerThreadGroup

public ThreadGroup getSchedulerThreadGroup()

Returns the name of the thread group for Quartz's main threads.

isSignalOnSchedulingChange

public boolean isSignalOnSchedulingChange()

setSignalOnSchedulingChange

public void setSignalOnSchedulingChange(boolean signalOnSchedulingChange)

start

public void start()
           throws SchedulerException

Starts the QuartzScheduler's threads that fire Triggers.

All Triggers that have misfired will be passed to the appropriate TriggerListener(s).

Specified by:

start in interface Scheduler

Throws:

SchedulerException - if shutdown() has been called, or there is an error within the Scheduler.

startDelayed

public void startDelayed(int seconds)
                  throws SchedulerException

Description copied from interface: Scheduler

Calls {#start()} after the indicated number of seconds. (This call does not block). This can be useful within applications that have initializers that create the scheduler immediately, before the resources needed by the executing jobs have been fully initialized.

Specified by:

startDelayed in interface Scheduler

Throws:

SchedulerException - if shutdown() has been called, or there is an error within the Scheduler.

standby

public void standby()

Temporarily halts the QuartzScheduler's firing of Triggers.

The scheduler is not destroyed, and can be re-started at any time.

Specified by:

standby in interface Scheduler

isInStandbyMode

public boolean isInStandbyMode()

Reports whether the Scheduler is paused.

Specified by:

isInStandbyMode in interface Scheduler

getJobStoreClass

public Class getJobStoreClass()

getThreadPoolClass

public Class getThreadPoolClass()

getThreadPoolSize

public int getThreadPoolSize()

shutdown

public void shutdown(boolean waitForJobsToComplete)

Halts the QuartzScheduler's firing of Triggers, and cleans up all resources associated with the QuartzScheduler.

The scheduler cannot be re-started.

Specified by:

shutdown in interface Scheduler

Parameters:

waitForJobsToComplete - if true the scheduler will not allow this method to return until all currently executing jobs have completed.

isShutdown

public boolean isShutdown()

Reports whether the Scheduler has been shutdown.

Specified by:

isShutdown in interface Scheduler

isShuttingDown

public boolean isShuttingDown()

isStarted

public boolean isStarted()

Description copied from interface: Scheduler

Whether the scheduler has been started.

Note: This only reflects whether Scheduler.start() has ever been called on this Scheduler, so it will return true even if the Scheduler is currently in standby mode or has been since shutdown.

Specified by:

isStarted in interface Scheduler

getCurrentlyExecutingJobs

public List<JobExecutionContext> getCurrentlyExecutingJobs()

Return a list of JobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance.

This method is not cluster aware. That is, it will only return Jobs currently executing in this Scheduler instance, not across the entire cluster.

Note that the list returned is an 'instantaneous' snap-shot, and that as soon as it's returned, the true list of executing jobs may be different.

Specified by:

getCurrentlyExecutingJobs in interface Scheduler

scheduleJob

public Date scheduleJob(JobDetail jobDetail,
                        OperableTrigger trigger)
                 throws SchedulerException

Add the Job identified by the given JobDetail to the Scheduler, and associate the given Trigger with it.

If the given Trigger does not reference any Job, then it will be set to reference the Job passed with it into this method.

Specified by:

scheduleJob in interface Scheduler

Throws:

SchedulerException - if the Job or Trigger cannot be added to the Scheduler, or there is an internal Scheduler error.

scheduleJob

public Date scheduleJob(OperableTrigger trigger)
                 throws SchedulerException

Schedule the given Trigger with the Job identified by the Trigger's settings.

Specified by:

scheduleJob in interface Scheduler

Throws:

SchedulerException - if the indicated Job does not exist, or the Trigger cannot be added to the Scheduler, or there is an internal Scheduler error.

addJob

public void addJob(JobDetail jobDetail)
            throws SchedulerException

Add the given Job to the Scheduler - with no associated Trigger. The Job will be 'dormant' until it is scheduled with a Trigger, or Scheduler.triggerJob() is called for it.

Specified by:

addJob in interface Scheduler

Throws:

SchedulerException - if there is an internal Scheduler error, or if the Job is not durable, or a Job with the same name already exists, and replace is false.

deleteJob

public void deleteJob(String jobKey)
               throws SchedulerException

Description copied from interface: Scheduler

Delete the identified Job from the Scheduler - and any associated Triggers.

Specified by:

deleteJob in interface Scheduler

Throws:

SchedulerException - if there is an internal Scheduler error.

unscheduleJob

public void unscheduleJob(String triggerKey)
                   throws SchedulerException

Description copied from interface: Scheduler

Remove the indicated Trigger from the scheduler.

If the related job does not have any other triggers, and the job is not durable, then the job will also be deleted.

Specified by:

unscheduleJob in interface Scheduler

Throws:

SchedulerException

rescheduleJob

public Date rescheduleJob(String triggerName,
                          OperableTrigger newTrigger)
                   throws SchedulerException

Description copied from interface: Scheduler

Remove (delete) the OperableTrigger with the given key, and store the new given one - which must be associated with the same job (the new trigger must have the job name specified) - however, the new trigger need not have the same name as the old trigger.

Specified by:

rescheduleJob in interface Scheduler

Parameters:

triggerName - identity of the trigger to replace

newTrigger - The new Trigger to be stored.

Returns:

null if a Trigger with the given name & group was not found and removed from the store, otherwise the first fire time of the newly scheduled trigger.

Throws:

SchedulerException

triggerJob

public void triggerJob(String jobKey,
                       JobDataMap data)
                throws SchedulerException

Trigger the identified Job (execute it now) - with a non-volatile trigger.

Specified by:

triggerJob in interface Scheduler

data - the (possibly null) JobDataMap to be associated with the trigger that fires the job immediately.

Throws:

SchedulerException

getTriggersOfJob

public List<Trigger> getTriggersOfJob(String jobKey)
                               throws SchedulerException

Get all Trigger s that are associated with the identified JobDetail.

Specified by:

getTriggersOfJob in interface Scheduler

Throws:

SchedulerException

getJobDetail

public JobDetail getJobDetail(String jobKey)
                       throws SchedulerException

Get the JobDetail for the Job instance with the given name and group.

Specified by:

getJobDetail in interface Scheduler

Throws:

SchedulerException

getTrigger

public Trigger getTrigger(String triggerKey)
                   throws SchedulerException

Get the Trigger instance with the given name and group.

Specified by:

getTrigger in interface Scheduler

Throws:

SchedulerException

getListenerManager

public ListenerManager getListenerManager()

Clears (deletes!) all scheduling data - all Jobs, Triggers Calendars.

Specified by:

getListenerManager in interface Scheduler

Returns:

the scheduler's ListenerManager

Throws:

SchedulerException

getInternalJobListeners

public List<JobListener> getInternalJobListeners()

Get a List containing all of the JobListeners in the Scheduler's internal list.

getInternalTriggerListeners

public List<TriggerListener> getInternalTriggerListeners()

Get a list containing all of the TriggerListeners in the Scheduler's internal list.

addInternalSchedulerListener

public void addInternalSchedulerListener(SchedulerListener schedulerListener)

Register the given SchedulerListener with the Scheduler's list of internal listeners.

removeInternalSchedulerListener

public boolean removeInternalSchedulerListener(SchedulerListener schedulerListener)

Remove the given SchedulerListener from the Scheduler's list of internal listeners.

Returns:

true if the identified listener was found in the list, and removed.

getInternalSchedulerListeners

public List<SchedulerListener> getInternalSchedulerListeners()

Get a List containing all of the internal SchedulerListeners registered with the Scheduler.

notifyJobStoreJobComplete

public void notifyJobStoreJobComplete(OperableTrigger trigger,
                                      JobDetail detail,
                                      Trigger.CompletedExecutionInstruction instCode)
                               throws JobPersistenceException

Throws:

JobPersistenceException

notifyJobStoreJobVetoed

public void notifyJobStoreJobVetoed(OperableTrigger trigger,
                                    JobDetail detail,
                                    Trigger.CompletedExecutionInstruction instCode)
                             throws JobPersistenceException

Throws:

JobPersistenceException

notifyTriggerListenersFired

public boolean notifyTriggerListenersFired(JobExecutionContext jec)
                                    throws SchedulerException

Throws:

SchedulerException

notifyTriggerListenersMisfired

public void notifyTriggerListenersMisfired(Trigger trigger)
                                    throws SchedulerException

Throws:

SchedulerException

notifyTriggerListenersComplete

public void notifyTriggerListenersComplete(JobExecutionContext jec,
                                           Trigger.CompletedExecutionInstruction instCode)
                                    throws SchedulerException

Throws:

SchedulerException

notifyJobListenersToBeExecuted

public void notifyJobListenersToBeExecuted(JobExecutionContext jec)
                                    throws SchedulerException

Throws:

SchedulerException

notifyJobListenersWasVetoed

public void notifyJobListenersWasVetoed(JobExecutionContext jec)
                                 throws SchedulerException

Throws:

SchedulerException

notifyJobListenersWasExecuted

public void notifyJobListenersWasExecuted(JobExecutionContext jec,
                                          JobExecutionException je)
                                   throws SchedulerException

Throws:

SchedulerException

notifySchedulerListenersError

public void notifySchedulerListenersError(String msg,
                                          SchedulerException se)

notifySchedulerListenersFinalized

public void notifySchedulerListenersFinalized(Trigger trigger)

notifySchedulerListenersJobDeleted

public void notifySchedulerListenersJobDeleted(String jobKey)

setJobFactory

public void setJobFactory(JobFactory factory)
                   throws SchedulerException

Description copied from interface: Scheduler

Set the JobFactory that will be responsible for producing instances of Job classes.

JobFactories may be of use to those wishing to have their application produce Job instances via some special mechanism, such as to give the opportunity for dependency injection.

Specified by:

setJobFactory in interface Scheduler

Throws:

SchedulerException

See Also:

org.quartz.spi.JobFactory

getJobFactory

public JobFactory getJobFactory()

getCascadingClassLoadHelper

public CascadingClassLoadHelper getCascadingClassLoadHelper()

Specified by:

getCascadingClassLoadHelper in interface Scheduler

getJobKeys

public Set<String> getJobKeys()
                       throws SchedulerException

Get the names of all the Jobs in the matching groups.

Specified by:

getJobKeys in interface Scheduler

Returns:

Set of all keys matching

Throws:

SchedulerException - On error