org.quartz

Interface Scheduler

All Known Implementing Classes:

RemoteMBeanScheduler, RemoteScheduler, StdScheduler

public interface Scheduler

This is the main interface of a Quartz Scheduler.

A Scheduler maintains a registery of JobDetail s and Triggers. Once registered, the Scheduler is responible for executing Job s when their associated Trigger s fire (when their scheduled time arrives).

Scheduler instances are produced by a SchedulerFactory. A scheduler that has already been created/initialized can be found and used through the same factory that produced it. After a Scheduler has been created, it is in "stand-by" mode, and must have its start() method called before it will fire any Jobs.

Job s are to be created by the 'client program', by defining a class that implements the Job interface. JobDetail objects are then created (also by the client) to define a individual instances of the Job. JobDetail instances can then be registered with the Scheduler via the scheduleJob(JobDetail, Trigger) or addJob(JobDetail, boolean) method.

Trigger s can then be defined to fire individual Job instances based on given schedules. SimpleTrigger s are most useful for one-time firings, or firing at an exact moment in time, with N repeats with a given delay between them. CronTrigger s allow scheduling based on time of day, day of week, day of month, and month of year.

Job s and Trigger s have a name and group associated with them, which should uniquely identify them within a single Scheduler. The 'group' feature may be useful for creating logical groupings or categorizations of Jobs s and Triggerss. If you don't have need for assigning a group to a given Jobs of Triggers, then you can use the DEFAULT_GROUP constant defined on this interface.

Stored Job s can also be 'manually' triggered through the use of the triggerJob(String jobName, String jobGroup) function.

Client programs may also be interested in the 'listener' interfaces that are available from Quartz. The JobListener interface provides notifications of Job executions. The TriggerListener interface provides notifications of Trigger firings. The SchedulerListener interface provides notifications of Scheduler events and errors.

The setup/configuration of a Scheduler instance is very customizable. Please consult the documentation distributed with Quartz.

Author:

James House, Sharada Jambula

See Also:

Job, JobDetail, Trigger, JobListener, TriggerListener, SchedulerListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FAIL_OVER_GROUP A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("FAILED_OVER_JOBS") for the name of a Trigger's group.
static java.lang.String	DEFAULT_GROUP A (possibly) usefull constant that can be used for specifying the group that Job and Trigger instances belong to.
static java.lang.String	DEFAULT_MANUAL_TRIGGERS A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("MANUAL_TRIGGER") for the name of a Trigger's group.
static java.lang.String	DEFAULT_RECOVERY_GROUP A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("RECOVERING_JOBS") for the name of a Trigger's group.
static java.lang.String	FAILED_JOB_ORIGINAL_TRIGGER_FIRETIME_IN_MILLISECONDS A constant JobDataMap key that can be used to retrieve the scheduled fire time of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.
static java.lang.String	FAILED_JOB_ORIGINAL_TRIGGER_GROUP A constant JobDataMap key that can be used to retrieve the group of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.
static java.lang.String	FAILED_JOB_ORIGINAL_TRIGGER_NAME A constant JobDataMap key that can be used to retrieve the name of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCalendar(java.lang.String calName, Calendar calendar, boolean replace, boolean updateTriggers) Add (register) the given Calendar to the Scheduler.
void	addGlobalJobListener(JobListener jobListener) Add the given JobListener to the Scheduler's global list.
void	addGlobalTriggerListener(TriggerListener triggerListener) Add the given TriggerListener to the Scheduler's global list.
void	addJob(JobDetail jobDetail, boolean replace) Add the given Job to the Scheduler - with no associated Trigger.
void	addJobListener(JobListener jobListener) Add the given JobListener to the Scheduler's list, of registered JobListeners.
void	addSchedulerListener(SchedulerListener schedulerListener) Register the given SchedulerListener with the Scheduler.
void	addTriggerListener(TriggerListener triggerListener) Add the given TriggerListener to the Scheduler's list, of registered TriggerListeners.
boolean	deleteCalendar(java.lang.String calName) Delete the identified Calendar from the Scheduler.
boolean	deleteJob(java.lang.String jobName, java.lang.String groupName) Delete the identified Job from the Scheduler - and any associated Triggers.
Calendar	getCalendar(java.lang.String calName) Get the Calendar instance with the given name.
java.lang.String[]	getCalendarNames() Get the names of all registered Calendars.
SchedulerContext	getContext() Returns the SchedulerContext of the Scheduler.
java.util.List	getCurrentlyExecutingJobs() Return a list of JobExecutionContext objects that represent all currently executing Jobs in this Scheduler instance.
JobListener	getGlobalJobListener(java.lang.String name) Get the globalJobListener that has the given name.
java.util.List	getGlobalJobListeners() Get a List containing all of the JobListener s in the Scheduler'sglobal list.
TriggerListener	getGlobalTriggerListener(java.lang.String name) Get the globalTriggerListener that has the given name.
java.util.List	getGlobalTriggerListeners() Get a List containing all of the TriggerListener s in the Scheduler'sglobal list.
JobDetail	getJobDetail(java.lang.String jobName, java.lang.String jobGroup) Get the JobDetail for the Job instance with the given name and group.
java.lang.String[]	getJobGroupNames() Get the names of all known JobDetail groups.
JobListener	getJobListener(java.lang.String name) Get the non-globalJobListener that has the given name.
java.util.Set	getJobListenerNames() Get a Set containing the names of all the non-globalJobListener s registered with the Scheduler.
java.lang.String[]	getJobNames(java.lang.String groupName) Get the names of all the JobDetails in the given group.
SchedulerMetaData	getMetaData() Get a SchedulerMetaData object describiing the settings and capabilities of the scheduler instance.
java.util.Set	getPausedTriggerGroups() Get the names of all Trigger groups that are paused.
java.lang.String	getSchedulerInstanceId() Returns the instance Id of the Scheduler.
java.util.List	getSchedulerListeners() Get a List containing all of the SchedulerListener s registered with the Scheduler.
java.lang.String	getSchedulerName() Returns the name of the Scheduler.
Trigger	getTrigger(java.lang.String triggerName, java.lang.String triggerGroup) Get the Trigger instance with the given name and group.
java.lang.String[]	getTriggerGroupNames() Get the names of all known Trigger groups.
TriggerListener	getTriggerListener(java.lang.String name) Get the non-globalTriggerListener that has the given name.
java.util.Set	getTriggerListenerNames() Get a Set containing the names of all the non-globalTriggerListener s registered with the Scheduler.
java.lang.String[]	getTriggerNames(java.lang.String groupName) Get the names of all the Triggers in the given group.
Trigger[]	getTriggersOfJob(java.lang.String jobName, java.lang.String groupName) Get all Trigger s that are associated with the identified JobDetail.
int	getTriggerState(java.lang.String triggerName, java.lang.String triggerGroup) Get the current state of the identified Trigger.
boolean	interrupt(java.lang.String jobName, java.lang.String groupName) Request the interruption, within this Scheduler instance, of all currently executing instances of the identified Job, which must be an implementor of the InterruptableJob interface.
boolean	isInStandbyMode() Reports whether the Scheduler is in stand-by mode.
boolean	isPaused() Deprecated.
boolean	isShutdown() Reports whether the Scheduler has been shutdown.
boolean	isStarted() Whether the scheduler has been started.
void	pause() Deprecated. replaced by better-named standby() method.
void	pauseAll() Pause all triggers - similar to calling pauseTriggerGroup(group) on every group, however, after using this method resumeAll() must be called to clear the scheduler's state of 'remembering' that all new triggers will be paused as they are added.
void	pauseJob(java.lang.String jobName, java.lang.String groupName) Pause the JobDetail with the given name - by pausing all of its current Triggers.
void	pauseJobGroup(java.lang.String groupName) Pause all of the JobDetails in the given group - by pausing all of their Triggers.
void	pauseTrigger(java.lang.String triggerName, java.lang.String groupName) Pause the Trigger with the given name.
void	pauseTriggerGroup(java.lang.String groupName) Pause all of the Triggers in the given group.
boolean	removeGlobalJobListener(JobListener jobListener) Deprecated. Use removeGlobalJobListener(String)
boolean	removeGlobalJobListener(java.lang.String name) Remove the identifed JobListener from the Scheduler's list of global listeners.
boolean	removeGlobalTriggerListener(java.lang.String name) Remove the identifed TriggerListener from the Scheduler's list of global listeners.
boolean	removeGlobalTriggerListener(TriggerListener triggerListener) Deprecated. Use removeGlobalTriggerListener(String)
boolean	removeJobListener(java.lang.String name) Remove the identifed JobListener from the Scheduler's list of registered listeners.
boolean	removeSchedulerListener(SchedulerListener schedulerListener) Remove the given SchedulerListener from the Scheduler.
boolean	removeTriggerListener(java.lang.String name) Remove the identifed TriggerListener from the Scheduler's list of registered listeners.
java.util.Date	rescheduleJob(java.lang.String triggerName, java.lang.String groupName, Trigger newTrigger) Remove (delete) the Trigger with the given name, and store the new given one - which must be associated with the same job (the new trigger must have the job name & group specified) - however, the new trigger need not have the same name as the old trigger.
void	resumeAll() Resume (un-pause) all triggers - similar to calling resumeTriggerGroup(group) on every group.
void	resumeJob(java.lang.String jobName, java.lang.String groupName) Resume (un-pause) the JobDetail with the given name.
void	resumeJobGroup(java.lang.String groupName) Resume (un-pause) all of the JobDetails in the given group.
void	resumeTrigger(java.lang.String triggerName, java.lang.String groupName) Resume (un-pause) the Trigger with the given name.
void	resumeTriggerGroup(java.lang.String groupName) Resume (un-pause) all of the Triggers in the given group.
java.util.Date	scheduleJob(JobDetail jobDetail, Trigger trigger) Add the given JobDetail to the Scheduler, and associate the given Trigger with it.
java.util.Date	scheduleJob(Trigger 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	shutdown() Halts the Scheduler's firing of Triggers, and cleans up all resources associated with the Scheduler.
void	shutdown(boolean waitForJobsToComplete) Halts the Scheduler's firing of Triggers, and cleans up all resources associated with the Scheduler.
void	standby() Temporarily halts the Scheduler's firing of Triggers.
void	start() Starts the Scheduler's threads that fire Triggers.
void	startDelayed(int seconds) Calls {#start()} after the indicated number of seconds.
void	triggerJob(java.lang.String jobName, java.lang.String groupName) Trigger the identified JobDetail (execute it now) - the generated trigger will be non-volatile.
void	triggerJob(java.lang.String jobName, java.lang.String groupName, JobDataMap data) Trigger the identified JobDetail (execute it now) - the generated trigger will be non-volatile.
void	triggerJobWithVolatileTrigger(java.lang.String jobName, java.lang.String groupName) Trigger the identified JobDetail (execute it now) - the generated trigger will be volatile.
void	triggerJobWithVolatileTrigger(java.lang.String jobName, java.lang.String groupName, JobDataMap data) Trigger the identified JobDetail (execute it now) - the generated trigger will be volatile.
boolean	unscheduleJob(java.lang.String triggerName, java.lang.String groupName) Remove the indicated Trigger from the scheduler.

Field Detail

DEFAULT_GROUP

static final java.lang.String DEFAULT_GROUP

A (possibly) usefull constant that can be used for specifying the group that Job and Trigger instances belong to.

See Also:

Constant Field Values

DEFAULT_MANUAL_TRIGGERS

static final java.lang.String DEFAULT_MANUAL_TRIGGERS

A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("MANUAL_TRIGGER") for the name of a Trigger's group.

See Also:

Constant Field Values

DEFAULT_RECOVERY_GROUP

static final java.lang.String DEFAULT_RECOVERY_GROUP

A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("RECOVERING_JOBS") for the name of a Trigger's group.

See Also:

JobDetail.requestsRecovery(), Constant Field Values

DEFAULT_FAIL_OVER_GROUP

static final java.lang.String DEFAULT_FAIL_OVER_GROUP

A constant Trigger group name used internally by the scheduler - clients should not use the value of this constant ("FAILED_OVER_JOBS") for the name of a Trigger's group.

See Also:

JobDetail.requestsRecovery(), Constant Field Values

FAILED_JOB_ORIGINAL_TRIGGER_NAME

static final java.lang.String FAILED_JOB_ORIGINAL_TRIGGER_NAME

A constant JobDataMap key that can be used to retrieve the name of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.

See Also:

JobDetail.requestsRecovery(), Constant Field Values

FAILED_JOB_ORIGINAL_TRIGGER_GROUP

static final java.lang.String FAILED_JOB_ORIGINAL_TRIGGER_GROUP

A constant JobDataMap key that can be used to retrieve the group of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.

See Also:

JobDetail.requestsRecovery(), Constant Field Values

FAILED_JOB_ORIGINAL_TRIGGER_FIRETIME_IN_MILLISECONDS

static final java.lang.String FAILED_JOB_ORIGINAL_TRIGGER_FIRETIME_IN_MILLISECONDS

A constant JobDataMap key that can be used to retrieve the scheduled fire time of the original Trigger from a recovery trigger's data map in the case of a job recovering after a failed scheduler instance.

See Also:

JobDetail.requestsRecovery(), Constant Field Values

Method Detail

getSchedulerName

java.lang.String getSchedulerName()
                                  throws SchedulerException

Returns the name of the Scheduler.

Throws:

SchedulerException

getSchedulerInstanceId

java.lang.String getSchedulerInstanceId()
                                        throws SchedulerException

Returns the instance Id of the Scheduler.

Throws:

SchedulerException

getContext

SchedulerContext getContext()
                            throws SchedulerException

Returns the SchedulerContext of the Scheduler.

Throws:

SchedulerException

start

void start()
           throws SchedulerException

Starts the Scheduler's threads that fire Triggers. When a scheduler is first created it is in "stand-by" mode, and will not fire triggers. The scheduler can also be put into stand-by mode by calling the standby() method.

The misfire/recovery process will be started, if it is the initial call to this method on this scheduler instance.

Throws:

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

See Also:

startDelayed(int), standby(), shutdown()

startDelayed

void startDelayed(int seconds)
                  throws SchedulerException

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.

Throws:

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

See Also:

start(), standby(), shutdown()

isStarted

boolean isStarted()
                  throws SchedulerException

Whether the scheduler has been started.

Note: This only reflects whether 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.

Throws:

SchedulerException

See Also:

start(), isShutdown(), isInStandbyMode()

standby

void standby()
             throws SchedulerException

Temporarily halts the Scheduler's firing of Triggers.

When start() is called (to bring the scheduler out of stand-by mode), trigger misfire instructions will NOT be applied during the execution of the start() method - any misfires will be detected immediately afterward (by the JobStore's normal process).

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

Throws:

SchedulerException

See Also:

start(), pauseAll()

pause

void pause()
           throws SchedulerException

Deprecated. replaced by better-named standby() method.

Throws:

SchedulerException

See Also:

standby()

isInStandbyMode

boolean isInStandbyMode()
                        throws SchedulerException

Reports whether the Scheduler is in stand-by mode.

Throws:

SchedulerException

See Also:

standby(), start()

isPaused

boolean isPaused()
                 throws SchedulerException

Deprecated.

Throws:

SchedulerException

See Also:

isInStandbyMode()

shutdown

void shutdown()
              throws SchedulerException

Halts the Scheduler's firing of Triggers, and cleans up all resources associated with the Scheduler. Equivalent to shutdown(false).

The scheduler cannot be re-started.

Throws:

SchedulerException

See Also:

shutdown(boolean)

shutdown

void shutdown(boolean waitForJobsToComplete)
              throws SchedulerException

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

The scheduler cannot be re-started.

Parameters:

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

Throws:

SchedulerException

See Also:

shutdown()

isShutdown

boolean isShutdown()
                   throws SchedulerException

Reports whether the Scheduler has been shutdown.

Throws:

SchedulerException

getMetaData

SchedulerMetaData getMetaData()
                              throws SchedulerException

Get a SchedulerMetaData object describiing the settings and capabilities of the scheduler instance.

Note that the data returned is an 'instantaneous' snap-shot, and that as soon as it's returned, the meta data values may be different.

Throws:

SchedulerException

getCurrentlyExecutingJobs

java.util.List getCurrentlyExecutingJobs()
                                         throws SchedulerException

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. Also please read the doc associated with JobExecutionContext- especially if you're using RMI.

Throws:

SchedulerException

See Also:

JobExecutionContext

setJobFactory

void setJobFactory(JobFactory factory)
                   throws SchedulerException

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 opertunity for dependency injection.

Throws:

SchedulerException

See Also:

JobFactory

scheduleJob

java.util.Date scheduleJob(JobDetail jobDetail,
                         Trigger trigger)
                           throws SchedulerException

Add 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.

Throws:

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

scheduleJob

java.util.Date scheduleJob(Trigger trigger)
                           throws SchedulerException

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

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.

unscheduleJob

boolean unscheduleJob(java.lang.String triggerName,
                    java.lang.String groupName)
                      throws SchedulerException

Remove the indicated Trigger from the scheduler.

Throws:

SchedulerException

rescheduleJob

java.util.Date rescheduleJob(java.lang.String triggerName,
                           java.lang.String groupName,
                           Trigger newTrigger)
                             throws SchedulerException

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

Parameters:

triggerName - The name of the Trigger to be replaced.

groupName - The group name of the Trigger to be replaced.

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

addJob

void addJob(JobDetail jobDetail,
          boolean replace)
            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.

The Job must by definition be 'durable', if it is not, SchedulerException will be thrown.

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

boolean deleteJob(java.lang.String jobName,
                java.lang.String groupName)
                  throws SchedulerException

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

Returns:

true if the Job was found and deleted.

Throws:

SchedulerException - if there is an internal Scheduler error.

triggerJob

void triggerJob(java.lang.String jobName,
              java.lang.String groupName)
                throws SchedulerException

Trigger the identified JobDetail (execute it now) - the generated trigger will be non-volatile.

Throws:

SchedulerException

triggerJobWithVolatileTrigger

void triggerJobWithVolatileTrigger(java.lang.String jobName,
                                 java.lang.String groupName)
                                   throws SchedulerException

Trigger the identified JobDetail (execute it now) - the generated trigger will be volatile.

Throws:

SchedulerException

triggerJob

void triggerJob(java.lang.String jobName,
              java.lang.String groupName,
              JobDataMap data)
                throws SchedulerException

Trigger the identified JobDetail (execute it now) - the generated trigger will be non-volatile.

Parameters:

jobName - the name of the Job to trigger

groupName - the group name of the Job to trigger

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

Throws:

SchedulerException

triggerJobWithVolatileTrigger

void triggerJobWithVolatileTrigger(java.lang.String jobName,
                                 java.lang.String groupName,
                                 JobDataMap data)
                                   throws SchedulerException

Trigger the identified JobDetail (execute it now) - the generated trigger will be volatile.

Parameters:

jobName - the name of the Job to trigger

groupName - the group name of the Job to trigger

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

Throws:

SchedulerException

pauseJob

void pauseJob(java.lang.String jobName,
            java.lang.String groupName)
              throws SchedulerException

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

Throws:

SchedulerException

See Also:

resumeJob(String, String)

pauseJobGroup

void pauseJobGroup(java.lang.String groupName)
                   throws SchedulerException

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

The Scheduler will "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:

SchedulerException

See Also:

resumeJobGroup(String)

pauseTrigger

void pauseTrigger(java.lang.String triggerName,
                java.lang.String groupName)
                  throws SchedulerException

Pause the Trigger with the given name.

Throws:

SchedulerException

See Also:

resumeTrigger(String, String)

pauseTriggerGroup

void pauseTriggerGroup(java.lang.String groupName)
                       throws SchedulerException

Pause all of the Triggers in the given group.

The Scheduler will "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:

SchedulerException

See Also:

resumeTriggerGroup(String)

resumeJob

void resumeJob(java.lang.String jobName,
             java.lang.String groupName)
               throws SchedulerException

Resume (un-pause) the JobDetail with the given name.

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

Throws:

SchedulerException

See Also:

pauseJob(String, String)

resumeJobGroup

void resumeJobGroup(java.lang.String groupName)
                    throws SchedulerException

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

SchedulerException

See Also:

pauseJobGroup(String)

resumeTrigger

void resumeTrigger(java.lang.String triggerName,
                 java.lang.String groupName)
                   throws SchedulerException

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

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

Throws:

SchedulerException

See Also:

pauseTrigger(String, String)

resumeTriggerGroup

void resumeTriggerGroup(java.lang.String groupName)
                        throws SchedulerException

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.

Throws:

SchedulerException

See Also:

pauseTriggerGroup(String)

pauseAll

void pauseAll()
              throws SchedulerException

Pause all triggers - similar to calling pauseTriggerGroup(group) on every group, however, after using this method resumeAll() must be called to clear the scheduler's state of 'remembering' that all new triggers will be paused as they are added.

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

Throws:

SchedulerException

See Also:

resumeAll(), pauseTriggerGroup(String), standby()

resumeAll

void resumeAll()
               throws SchedulerException

Resume (un-pause) all triggers - similar to 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:

SchedulerException

See Also:

pauseAll()

getJobGroupNames

java.lang.String[] getJobGroupNames()
                                    throws SchedulerException

Get the names of all known JobDetail groups.

Throws:

SchedulerException

getJobNames

java.lang.String[] getJobNames(java.lang.String groupName)
                               throws SchedulerException

Get the names of all the JobDetails in the given group.

Throws:

SchedulerException

getTriggersOfJob

Trigger[] getTriggersOfJob(java.lang.String jobName,
                         java.lang.String groupName)
                           throws SchedulerException

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

Throws:

SchedulerException

getTriggerGroupNames

java.lang.String[] getTriggerGroupNames()
                                        throws SchedulerException

Get the names of all known Trigger groups.

Throws:

SchedulerException

getTriggerNames

java.lang.String[] getTriggerNames(java.lang.String groupName)
                                   throws SchedulerException

Get the names of all the Triggers in the given group.

Throws:

SchedulerException

getPausedTriggerGroups

java.util.Set getPausedTriggerGroups()
                                     throws SchedulerException

Get the names of all Trigger groups that are paused.

Throws:

SchedulerException

getJobDetail

JobDetail getJobDetail(java.lang.String jobName,
                     java.lang.String jobGroup)
                       throws SchedulerException

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

Throws:

SchedulerException

getTrigger

Trigger getTrigger(java.lang.String triggerName,
                 java.lang.String triggerGroup)
                   throws SchedulerException

Get the Trigger instance with the given name and group.

Throws:

SchedulerException

getTriggerState

int getTriggerState(java.lang.String triggerName,
                  java.lang.String triggerGroup)
                    throws SchedulerException

Get the current state of the identified Trigger.

Throws:

SchedulerException

See Also:

Trigger.STATE_NORMAL, Trigger.STATE_PAUSED, Trigger.STATE_COMPLETE, Trigger.STATE_ERROR, Trigger.STATE_BLOCKED, Trigger.STATE_NONE

addCalendar

void addCalendar(java.lang.String calName,
               Calendar calendar,
               boolean replace,
               boolean updateTriggers)
                 throws SchedulerException

Add (register) the given Calendar to the Scheduler.

Parameters:

updateTriggers - whether or not to update existing triggers that referenced the already existing calendar so that they are 'correct' based on the new trigger.

Throws:

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

deleteCalendar

boolean deleteCalendar(java.lang.String calName)
                       throws SchedulerException

Delete the identified Calendar from the Scheduler.

Returns:

true if the Calendar was found and deleted.

Throws:

SchedulerException - if there is an internal Scheduler error.

getCalendar

Calendar getCalendar(java.lang.String calName)
                     throws SchedulerException

Get the Calendar instance with the given name.

Throws:

SchedulerException

getCalendarNames

java.lang.String[] getCalendarNames()
                                    throws SchedulerException

Get the names of all registered Calendars.

Throws:

SchedulerException

interrupt

boolean interrupt(java.lang.String jobName,
                java.lang.String groupName)
                  throws UnableToInterruptJobException

Request the interruption, within this Scheduler instance, of all currently executing instances of the identified Job, which must be an implementor of the InterruptableJob interface.

If more than one instance of the identified job is currently executing, the InterruptableJob#interrupt() method will be called on each instance. However, there is a limitation that in the case that interrupt() on one instances throws an exception, all remaining instances (that have not yet been interrupted) will not have their interrupt() method called.

If you wish to interrupt a specific instance of a job (when more than one is executing) you can do so by calling getCurrentlyExecutingJobs() to obtain a handle to the job instance, and then invoke interrupt() on it yourself.

This method is not cluster aware. That is, it will only interrupt instances of the identified InterruptableJob currently executing in this Scheduler instance, not across the entire cluster.

Parameters:

jobName -

groupName -

Returns:

true is at least one instance of the identified job was found and interrupted.

Throws:

UnableToInterruptJobException - if the job does not implement InterruptableJob, or there is an exception while interrupting the job.

See Also:

InterruptableJob.interrupt(), getCurrentlyExecutingJobs()

addGlobalJobListener

void addGlobalJobListener(JobListener jobListener)
                          throws SchedulerException

Add the given JobListener to the Scheduler's global list.

Listeners in the 'global' list receive notification of execution events for ALL JobDetails.

Throws:

SchedulerException

addJobListener

void addJobListener(JobListener jobListener)
                    throws SchedulerException

Add the given JobListener to the Scheduler's list, of registered JobListeners.

Throws:

SchedulerException

removeGlobalJobListener

boolean removeGlobalJobListener(JobListener jobListener)
                                throws SchedulerException

Deprecated. Use removeGlobalJobListener(String)

Remove the given JobListener from the Scheduler's list of global listeners.

Returns:

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

Throws:

SchedulerException

removeGlobalJobListener

boolean removeGlobalJobListener(java.lang.String name)
                                throws SchedulerException

Remove the identifed JobListener from the Scheduler's list of global listeners.

Returns:

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

Throws:

SchedulerException

removeJobListener

boolean removeJobListener(java.lang.String name)
                          throws SchedulerException

Remove the identifed JobListener from the Scheduler's list of registered listeners.

Returns:

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

Throws:

SchedulerException

getGlobalJobListeners

java.util.List getGlobalJobListeners()
                                     throws SchedulerException

Get a List containing all of the JobListener s in the Scheduler'sglobal list.

Throws:

SchedulerException

getJobListenerNames

java.util.Set getJobListenerNames()
                                  throws SchedulerException

Get a Set containing the names of all the non-globalJobListener s registered with the Scheduler.

Throws:

SchedulerException

getGlobalJobListener

JobListener getGlobalJobListener(java.lang.String name)
                                 throws SchedulerException

Get the globalJobListener that has the given name.

Throws:

SchedulerException

getJobListener

JobListener getJobListener(java.lang.String name)
                           throws SchedulerException

Get the non-globalJobListener that has the given name.

Throws:

SchedulerException

addGlobalTriggerListener

void addGlobalTriggerListener(TriggerListener triggerListener)
                              throws SchedulerException

Add the given TriggerListener to the Scheduler's global list.

Listeners in the 'global' list receive notification of execution events for ALL Triggers.

Throws:

SchedulerException

addTriggerListener

void addTriggerListener(TriggerListener triggerListener)
                        throws SchedulerException

Add the given TriggerListener to the Scheduler's list, of registered TriggerListeners.

Throws:

SchedulerException

removeGlobalTriggerListener

boolean removeGlobalTriggerListener(TriggerListener triggerListener)
                                    throws SchedulerException

Deprecated. Use removeGlobalTriggerListener(String)

Remove the given TriggerListener from the Scheduler's list of global listeners.

Returns:

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

Throws:

SchedulerException

removeGlobalTriggerListener

boolean removeGlobalTriggerListener(java.lang.String name)
                                    throws SchedulerException

Remove the identifed TriggerListener from the Scheduler's list of global listeners.

Returns:

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

Throws:

SchedulerException

removeTriggerListener

boolean removeTriggerListener(java.lang.String name)
                              throws SchedulerException

Remove the identifed TriggerListener from the Scheduler's list of registered listeners.

Returns:

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

Throws:

SchedulerException

getGlobalTriggerListeners

java.util.List getGlobalTriggerListeners()
                                         throws SchedulerException

Get a List containing all of the TriggerListener s in the Scheduler'sglobal list.

Throws:

SchedulerException

getTriggerListenerNames

java.util.Set getTriggerListenerNames()
                                      throws SchedulerException

Get a Set containing the names of all the non-globalTriggerListener s registered with the Scheduler.

Throws:

SchedulerException

getGlobalTriggerListener

TriggerListener getGlobalTriggerListener(java.lang.String name)
                                         throws SchedulerException

Get the globalTriggerListener that has the given name.

Throws:

SchedulerException

getTriggerListener

TriggerListener getTriggerListener(java.lang.String name)
                                   throws SchedulerException

Get the non-globalTriggerListener that has the given name.

Throws:

SchedulerException

addSchedulerListener

void addSchedulerListener(SchedulerListener schedulerListener)
                          throws SchedulerException

Register the given SchedulerListener with the Scheduler.

Throws:

SchedulerException

removeSchedulerListener

boolean removeSchedulerListener(SchedulerListener schedulerListener)
                                throws SchedulerException

Remove the given SchedulerListener from the Scheduler.

Returns:

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

Throws:

SchedulerException

getSchedulerListeners

java.util.List getSchedulerListeners()
                                     throws SchedulerException

Get a List containing all of the SchedulerListener s registered with the Scheduler.

Throws:

SchedulerException