QuartzScheduler (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.core.QuartzScheduler

All Implemented Interfaces:

IQuartzScheduler
```
public class QuartzScheduler
extends Object
implements IQuartzScheduler
```
This is the heart of Quartz, an indirect implementation of the IScheduler interface, containing methods to schedule IJobs, register IJobListener instances, etc.

Author:

James House

See Also:

IScheduler, QuartzSchedulerThread, IJobStore, IThreadPool

Constructor Summary

Constructors
Constructor and Description
`QuartzScheduler(QuartzSchedulerResources resources, long idleWaitTime)` Create a `QuartzScheduler` with the given configuration properties.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCalendar(String calName, ICalendar calendar, boolean replace, boolean updateTriggers)` Add (register) the given `Calendar` to the Scheduler.
`void`	`addInternalJobListener(IJobListener jobListener)` Add the given `IJobListener` to the `Scheduler`'s internal list.
`void`	`addInternalSchedulerListener(ISchedulerListener schedulerListener)` Register the given `ISchedulerListener` with the `Scheduler`'s list of internal listeners.
`void`	`addInternalTriggerListener(ITriggerListener triggerListener)` Add the given `ITriggerListener` to the `Scheduler`'s internal list.
`void`	`addJob(IJobDetail jobDetail, boolean replace)` Add the given `Job` to the Scheduler - with no associated `Trigger`.
`void`	`addJob(IJobDetail jobDetail, boolean replace, boolean storeNonDurableWhileAwaitingScheduling)`
`void`	`addNoGCObject(Object obj)`
`boolean`	`checkExists(JobKey jobKey)` Determine whether a `IJob` 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`	`clear()` Clears (deletes!)
`boolean`	`deleteCalendar(String calName)` Delete the identified `Calendar` from the Scheduler.
`boolean`	`deleteJob(JobKey jobKey)` Delete the identified `Job` from the Scheduler - and any associated `Trigger`s.
`boolean`	`deleteJobs(List<JobKey> jobKeys)`
`ICalendar`	`getCalendar(String calName)` Get the `ICalendar` instance with the given name.
`com.helger.commons.collection.impl.ICommonsList<String>`	`getCalendarNames()` Get the names of all registered `ICalendars`.
`com.helger.commons.collection.impl.ICommonsList<IJobExecutionContext>`	`getCurrentlyExecutingJobs()` Return a list of `JobExecutionContext` objects that represent all currently executing Jobs in this Scheduler instance.
`IJobListener`	`getInternalJobListener(String name)` Get the internal `IJobListener` that has the given name.
`com.helger.commons.collection.impl.ICommonsList<IJobListener>`	`getInternalJobListeners()` Get a List containing all of the `IJobListener`s in the `Scheduler`'s internal list.
`com.helger.commons.collection.impl.ICommonsList<ISchedulerListener>`	`getInternalSchedulerListeners()` Get a List containing all of the internal `ISchedulerListener`s registered with the `Scheduler`.
`ITriggerListener`	`getInternalTriggerListener(String name)` Get the internal `ITriggerListener` that has the given name.
`com.helger.commons.collection.impl.ICommonsList<ITriggerListener>`	`getInternalTriggerListeners()` Get a list containing all of the `ITriggerListener`s in the `Scheduler`'s internal list.
`IJobDetail`	`getJobDetail(JobKey jobKey)` Get the `IJobDetail` for the `Job` instance with the given name and group.
`IJobFactory`	`getJobFactory()`
`com.helger.commons.collection.impl.ICommonsList<String>`	`getJobGroupNames()` Get the names of all known `IJob` groups.
`com.helger.commons.collection.impl.ICommonsSet<JobKey>`	`getJobKeys(GroupMatcher<JobKey> matcher)` Get the names of all the `IJobs` in the matching groups.
`Class<?>`	`getJobStoreClass()`
`IListenerManager`	`getListenerManager()`
`com.helger.commons.collection.impl.ICommonsSet<String>`	`getPausedTriggerGroups()`
`SchedulerContext`	`getSchedulerContext()` Returns the `SchedulerContext` of the `Scheduler`.
`String`	`getSchedulerInstanceId()` Returns the instance Id of the `QuartzScheduler`.
`String`	`getSchedulerName()` Returns the name of the `QuartzScheduler`.
`ISchedulerSignaler`	`getSchedulerSignaler()`
`ThreadGroup`	`getSchedulerThreadGroup()` Returns the name of the thread group for Quartz's main threads.
`Class<?>`	`getThreadPoolClass()`
`int`	`getThreadPoolSize()`
`ITrigger`	`getTrigger(TriggerKey triggerKey)` Get the `ITrigger` instance with the given name and group.
`com.helger.commons.collection.impl.ICommonsList<String>`	`getTriggerGroupNames()` Get the names of all known `ITrigger` groups.
`com.helger.commons.collection.impl.ICommonsSet<TriggerKey>`	`getTriggerKeys(GroupMatcher<TriggerKey> matcher)` Get the names of all the `ITriggers` in the matching groups.
`com.helger.commons.collection.impl.ICommonsList<? extends ITrigger>`	`getTriggersOfJob(JobKey jobKey)` Get all `ITrigger` s that are associated with the identified `IJobDetail`.
`ITrigger.ETriggerState`	`getTriggerState(TriggerKey triggerKey)` Get the current state of the identified `ITrigger`.
`String`	`getVersion()`
`static String`	`getVersionIteration()`
`static String`	`getVersionMajor()`
`static String`	`getVersionMinor()`
`void`	`initialize()`
`boolean`	`interrupt(JobKey jobKey)` Interrupt all instances of the identified InterruptableJob executing in this Scheduler instance.
`boolean`	`interrupt(String fireInstanceId)` Interrupt the identified InterruptableJob executing in this Scheduler instance.
`boolean`	`isClustered()`
`boolean`	`isInStandbyMode()` Reports whether the `Scheduler` is paused.
`boolean`	`isShutdown()` Reports whether the `Scheduler` has been shutdown.
`boolean`	`isShuttingDown()`
`boolean`	`isSignalOnSchedulingChange()`
`boolean`	`isStarted()`
`void`	`notifyJobListenersToBeExecuted(IJobExecutionContext jec)`
`void`	`notifyJobListenersWasExecuted(IJobExecutionContext jec, JobExecutionException je)`
`void`	`notifyJobListenersWasVetoed(IJobExecutionContext jec)`
`protected void`	`notifyJobStoreJobComplete(IOperableTrigger trigger, IJobDetail detail, ITrigger.ECompletedExecutionInstruction instCode)`
`protected void`	`notifyJobStoreJobVetoed(IOperableTrigger trigger, IJobDetail detail, ITrigger.ECompletedExecutionInstruction instCode)`
`void`	`notifySchedulerListenersError(String msg, SchedulerException se)`
`void`	`notifySchedulerListenersFinalized(ITrigger trigger)`
`void`	`notifySchedulerListenersInStandbyMode()`
`void`	`notifySchedulerListenersJobAdded(IJobDetail jobDetail)`
`void`	`notifySchedulerListenersJobDeleted(JobKey jobKey)`
`void`	`notifySchedulerListenersPausedJob(JobKey key)`
`void`	`notifySchedulerListenersPausedJobs(String group)`
`void`	`notifySchedulerListenersPausedTrigger(TriggerKey triggerKey)`
`void`	`notifySchedulerListenersPausedTriggers(String group)`
`void`	`notifySchedulerListenersResumedJob(JobKey key)`
`void`	`notifySchedulerListenersResumedJobs(String group)`
`void`	`notifySchedulerListenersResumedTrigger(TriggerKey key)`
`void`	`notifySchedulerListenersResumedTriggers(String group)`
`void`	`notifySchedulerListenersSchduled(ITrigger trigger)`
`void`	`notifySchedulerListenersShutdown()`
`void`	`notifySchedulerListenersShuttingdown()`
`void`	`notifySchedulerListenersStarted()`
`void`	`notifySchedulerListenersStarting()`
`void`	`notifySchedulerListenersUnscheduled(TriggerKey triggerKey)`
`protected void`	`notifySchedulerThread(long candidateNewNextFireTime)`
`void`	`notifyTriggerListenersComplete(IJobExecutionContext jec, ITrigger.ECompletedExecutionInstruction instCode)`
`boolean`	`notifyTriggerListenersFired(IJobExecutionContext jec)`
`void`	`notifyTriggerListenersMisfired(ITrigger trigger)`
`int`	`numJobsExecuted()`
`void`	`pauseAll()` Pause all triggers - equivalent of calling `pauseTriggers(GroupMatcher<TriggerKey>)` with a matcher matching all known groups.
`void`	`pauseJob(JobKey jobKey)` Pause the `IJobDetail` with the given name - by pausing all of its current `Trigger`s.
`void`	`pauseJobs(GroupMatcher<JobKey> groupMatcher)` Pause all of the `IJobDetails` in the matching groups - by pausing all of their `Trigger`s.
`void`	`pauseTrigger(TriggerKey triggerKey)` Pause the `ITrigger` with the given name.
`void`	`pauseTriggers(GroupMatcher<TriggerKey> matcher)` Pause all of the `ITriggers` in the matching groups.
`boolean`	`removeInternalJobListener(String name)` Remove the identified `IJobListener` from the `Scheduler`'s list of internal listeners.
`boolean`	`removeInternalSchedulerListener(ISchedulerListener schedulerListener)` Remove the given `ISchedulerListener` from the `Scheduler`'s list of internal listeners.
`boolean`	`removeinternalTriggerListener(String name)` Remove the identified `ITriggerListener` from the `Scheduler`'s list of internal listeners.
`boolean`	`removeNoGCObject(Object obj)`
`Date`	`rescheduleJob(TriggerKey triggerKey, ITrigger newTrigger)` Remove (delete) the `ITrigger` with the given name, 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 `IJobDetail` with the given name.
`void`	`resumeJobs(GroupMatcher<JobKey> matcher)` Resume (un-pause) all of the `IJobDetails` in the matching groups.
`void`	`resumeTrigger(TriggerKey triggerKey)` Resume (un-pause) the `ITrigger` with the given name.
`void`	`resumeTriggers(GroupMatcher<TriggerKey> matcher)` Resume (un-pause) all of the `ITriggers` in the matching groups.
`Date`	`runningSince()`
`Date`	`scheduleJob(IJobDetail jobDetail, ITrigger trigger)` Add the `IJob` identified by the given `IJobDetail` to the Scheduler, and associate the given `ITrigger` with it.
`void`	`scheduleJob(IJobDetail jobDetail, Set<? extends ITrigger> triggersForJob, boolean replace)`
`Date`	`scheduleJob(ITrigger trigger)` Schedule the given `ITrigger` with the `Job` identified by the `Trigger`'s settings.
`void`	`scheduleJobs(Map<IJobDetail,Set<? extends ITrigger>> triggersAndJobs, boolean replace)`
`void`	`setJobFactory(IJobFactory aFactory)`
`void`	`setSignalOnSchedulingChange(boolean signalOnSchedulingChange)`
`void`	`shutdown()` Halts the `QuartzScheduler`'s firing of `ITriggers`, and cleans up all resources associated with the QuartzScheduler.
`void`	`shutdown(boolean waitForJobsToComplete)` Halts the `QuartzScheduler`'s firing of `ITriggers`, and cleans up all resources associated with the QuartzScheduler.
`void`	`standby()` Temporarily halts the `QuartzScheduler`'s firing of `ITriggers`.
`void`	`start()` Starts the `QuartzScheduler`'s threads that fire `ITriggers`.
`void`	`startDelayed(int seconds)`
`boolean`	`supportsPersistence()`
`void`	`triggerJob(IOperableTrigger trig)` Store and schedule the identified `IOperableTrigger`
`void`	`triggerJob(JobKey jobKey, JobDataMap data)` Trigger the identified `IJob` (execute it now) - with a non-volatile trigger.
`boolean`	`unscheduleJob(TriggerKey triggerKey)` Remove the indicated `ITrigger` from the scheduler.
`boolean`	`unscheduleJobs(List<TriggerKey> triggerKeys)`
`void`	`validateState()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QuartzScheduler
```
public QuartzScheduler(QuartzSchedulerResources resources,
                       long idleWaitTime)
                throws SchedulerException
```
    Create a QuartzScheduler with the given configuration properties.
    
    Throws:
    
    SchedulerException - On error
    
    See Also:
    
    QuartzSchedulerResources
- Method Detail
  - initialize
```
public void initialize()
                throws SchedulerException
```
    Throws:
    
    SchedulerException - on error
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface IQuartzScheduler
  - getVersionMajor
```
public static String getVersionMajor()
```
  - getVersionMinor
```
public static String getVersionMinor()
```
  - getVersionIteration
```
public static String getVersionIteration()
```
  - getSchedulerSignaler
```
public ISchedulerSignaler getSchedulerSignaler()
```
  - getSchedulerName
```
public String getSchedulerName()
```
    Returns the name of the QuartzScheduler.
    
    Specified by:
    
    getSchedulerName in interface IQuartzScheduler
  - getSchedulerInstanceId
```
public String getSchedulerInstanceId()
```
    Returns the instance Id of the QuartzScheduler.
    
    Specified by:
    
    getSchedulerInstanceId in interface IQuartzScheduler
  - getSchedulerThreadGroup
```
public ThreadGroup getSchedulerThreadGroup()
```
    Returns the name of the thread group for Quartz's main threads.
  - addNoGCObject
```
public void addNoGCObject(Object obj)
```
  - removeNoGCObject
```
public boolean removeNoGCObject(Object obj)
```
  - getSchedulerContext
```
public SchedulerContext getSchedulerContext()
                                     throws SchedulerException
```
    Returns the SchedulerContext of the Scheduler.
    
    Specified by:
    
    getSchedulerContext in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - isSignalOnSchedulingChange
```
public boolean isSignalOnSchedulingChange()
```
  - setSignalOnSchedulingChange
```
public void setSignalOnSchedulingChange(boolean signalOnSchedulingChange)
```
  - start
```
public void start()
           throws SchedulerException
```
    Starts the QuartzScheduler's threads that fire ITriggers.
    
    All ITriggers that have misfired will be passed to the appropriate TriggerListener(s).
    
    Specified by:
    
    start in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - startDelayed
```
public void startDelayed(int seconds)
                  throws SchedulerException
```
    Specified by:
    
    startDelayed in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - standby
```
public void standby()
```
    Temporarily halts the QuartzScheduler's firing of ITriggers.
    
    The scheduler is not destroyed, and can be re-started at any time.
    
    Specified by:
    
    standby in interface IQuartzScheduler
  - isInStandbyMode
```
public boolean isInStandbyMode()
```
    Reports whether the Scheduler is paused.
    
    Specified by:
    
    isInStandbyMode in interface IQuartzScheduler
  - runningSince
```
public Date runningSince()
```
    Specified by:
    
    runningSince in interface IQuartzScheduler
  - numJobsExecuted
```
public int numJobsExecuted()
```
    Specified by:
    
    numJobsExecuted in interface IQuartzScheduler
  - getJobStoreClass
```
public Class<?> getJobStoreClass()
```
    Specified by:
    
    getJobStoreClass in interface IQuartzScheduler
  - supportsPersistence
```
public boolean supportsPersistence()
```
    Specified by:
    
    supportsPersistence in interface IQuartzScheduler
  - isClustered
```
public boolean isClustered()
```
    Specified by:
    
    isClustered in interface IQuartzScheduler
  - getThreadPoolClass
```
public Class<?> getThreadPoolClass()
```
    Specified by:
    
    getThreadPoolClass in interface IQuartzScheduler
  - getThreadPoolSize
```
public int getThreadPoolSize()
```
    Specified by:
    
    getThreadPoolSize in interface IQuartzScheduler
  - shutdown
```
public void shutdown()
```
    Halts the QuartzScheduler's firing of ITriggers, and cleans up all resources associated with the QuartzScheduler. Equivalent to shutdown(false).
    
    The scheduler cannot be re-started.
    
    Specified by:
    
    shutdown in interface IQuartzScheduler
  - shutdown
```
public void shutdown(boolean waitForJobsToComplete)
```
    Halts the QuartzScheduler's firing of ITriggers, and cleans up all resources associated with the QuartzScheduler.
    
    The scheduler cannot be re-started.
    
    Specified by:
    
    shutdown in interface IQuartzScheduler
    
    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 IQuartzScheduler
  - isShuttingDown
```
public boolean isShuttingDown()
```
  - isStarted
```
public boolean isStarted()
```
  - validateState
```
public void validateState()
                   throws SchedulerException
```
    Throws:
    
    SchedulerException
  - getCurrentlyExecutingJobs
```
public com.helger.commons.collection.impl.ICommonsList<IJobExecutionContext> 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 IQuartzScheduler
  - scheduleJob
```
public Date scheduleJob(IJobDetail jobDetail,
                        ITrigger trigger)
                 throws SchedulerException
```
    Add the IJob identified by the given IJobDetail to the Scheduler, and associate the given ITrigger 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 IQuartzScheduler
    
    Throws:
    
    SchedulerException - if the Job or Trigger cannot be added to the Scheduler, or there is an internal Scheduler error.
  - scheduleJob
```
public Date scheduleJob(ITrigger trigger)
                 throws SchedulerException
```
    Schedule the given ITrigger with the Job identified by the Trigger's settings.
    
    Specified by:
    
    scheduleJob in interface IQuartzScheduler
    
    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(IJobDetail 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.
    
    Specified by:
    
    addJob in interface IQuartzScheduler
    
    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.
  - addJob
```
public void addJob(IJobDetail jobDetail,
                   boolean replace,
                   boolean storeNonDurableWhileAwaitingScheduling)
            throws SchedulerException
```
    Specified by:
    
    addJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - deleteJob
```
public boolean deleteJob(JobKey jobKey)
                  throws SchedulerException
```
    Delete the identified Job from the Scheduler - and any associated Triggers.
    
    Specified by:
    
    deleteJob in interface IQuartzScheduler
    
    Returns:
    
    true if the Job was found and deleted.
    
    Throws:
    
    SchedulerException - if there is an internal Scheduler error.
  - deleteJobs
```
public boolean deleteJobs(List<JobKey> jobKeys)
                   throws SchedulerException
```
    Specified by:
    
    deleteJobs in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - scheduleJobs
```
public void scheduleJobs(Map<IJobDetail,Set<? extends ITrigger>> triggersAndJobs,
                         boolean replace)
                  throws SchedulerException
```
    Specified by:
    
    scheduleJobs in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - scheduleJob
```
public void scheduleJob(IJobDetail jobDetail,
                        Set<? extends ITrigger> triggersForJob,
                        boolean replace)
                 throws SchedulerException
```
    Specified by:
    
    scheduleJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - unscheduleJobs
```
public boolean unscheduleJobs(List<TriggerKey> triggerKeys)
                       throws SchedulerException
```
    Specified by:
    
    unscheduleJobs in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - unscheduleJob
```
public boolean unscheduleJob(TriggerKey triggerKey)
                      throws SchedulerException
```
    Remove the indicated ITrigger from the scheduler.
    
    Specified by:
    
    unscheduleJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - rescheduleJob
```
public Date rescheduleJob(TriggerKey triggerKey,
                          ITrigger newTrigger)
                   throws SchedulerException
```
    Remove (delete) the ITrigger with the given name, and store the new given one - which must be associated with the same job.
    
    Specified by:
    
    rescheduleJob in interface IQuartzScheduler
    
    Parameters:
    
    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(JobKey jobKey,
                       JobDataMap data)
                throws SchedulerException
```
    Trigger the identified IJob (execute it now) - with a non-volatile trigger.
    
    Specified by:
    
    triggerJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - triggerJob
```
public void triggerJob(IOperableTrigger trig)
                throws SchedulerException
```
    Store and schedule the identified IOperableTrigger
    
    Specified by:
    
    triggerJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - pauseTrigger
```
public void pauseTrigger(TriggerKey triggerKey)
                  throws SchedulerException
```
    Pause the ITrigger with the given name.
    
    Specified by:
    
    pauseTrigger in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - pauseTriggers
```
public void pauseTriggers(GroupMatcher<TriggerKey> matcher)
                   throws SchedulerException
```
    Pause all of the ITriggers in the matching groups.
    
    Specified by:
    
    pauseTriggers in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - pauseJob
```
public void pauseJob(JobKey jobKey)
              throws SchedulerException
```
    Pause the IJobDetail with the given name - by pausing all of its current Triggers.
    
    Specified by:
    
    pauseJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - pauseJobs
```
public void pauseJobs(GroupMatcher<JobKey> groupMatcher)
               throws SchedulerException
```
    Pause all of the IJobDetails in the matching groups - by pausing all of their Triggers.
    
    Specified by:
    
    pauseJobs in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - resumeTrigger
```
public void resumeTrigger(TriggerKey triggerKey)
                   throws SchedulerException
```
    Resume (un-pause) the ITrigger with the given name.
    
    If the Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.
    
    Specified by:
    
    resumeTrigger in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - resumeTriggers
```
public void resumeTriggers(GroupMatcher<TriggerKey> matcher)
                    throws SchedulerException
```
    Resume (un-pause) all of the ITriggers in the matching groups.
    
    If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.
    
    Specified by:
    
    resumeTriggers in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getPausedTriggerGroups
```
public com.helger.commons.collection.impl.ICommonsSet<String> getPausedTriggerGroups()
                                                                              throws SchedulerException
```
    Specified by:
    
    getPausedTriggerGroups in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - resumeJob
```
public void resumeJob(JobKey jobKey)
               throws SchedulerException
```
    Resume (un-pause) the IJobDetail 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.
    
    Specified by:
    
    resumeJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - resumeJobs
```
public void resumeJobs(GroupMatcher<JobKey> matcher)
                throws SchedulerException
```
    Resume (un-pause) all of the IJobDetails in the matching groups.
    
    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.
    
    Specified by:
    
    resumeJobs in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - pauseAll
```
public void pauseAll()
              throws SchedulerException
```
    Pause all triggers - equivalent of calling pauseTriggers(GroupMatcher<TriggerKey>) with a matcher matching all known groups.
    
    When resumeAll() is called (to un-pause), trigger misfire instructions WILL be applied.
    
    Specified by:
    
    pauseAll in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
    
    See Also:
    
    resumeAll(), pauseTriggers(GroupMatcher), standby()
  - resumeAll
```
public void resumeAll()
               throws SchedulerException
```
    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.
    
    Specified by:
    
    resumeAll in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
    
    See Also:
    
    pauseAll()
  - getJobGroupNames
```
public com.helger.commons.collection.impl.ICommonsList<String> getJobGroupNames()
                                                                         throws SchedulerException
```
    Get the names of all known IJob groups.
    
    Specified by:
    
    getJobGroupNames in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getJobKeys
```
public com.helger.commons.collection.impl.ICommonsSet<JobKey> getJobKeys(GroupMatcher<JobKey> matcher)
                                                                  throws SchedulerException
```
    Get the names of all the IJobs in the matching groups.
    
    Specified by:
    
    getJobKeys in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getTriggersOfJob
```
public com.helger.commons.collection.impl.ICommonsList<? extends ITrigger> getTriggersOfJob(JobKey jobKey)
                                                                                     throws SchedulerException
```
    Get all ITrigger s that are associated with the identified IJobDetail.
    
    Specified by:
    
    getTriggersOfJob in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getTriggerGroupNames
```
public com.helger.commons.collection.impl.ICommonsList<String> getTriggerGroupNames()
                                                                             throws SchedulerException
```
    Get the names of all known ITrigger groups.
    
    Specified by:
    
    getTriggerGroupNames in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getTriggerKeys
```
public com.helger.commons.collection.impl.ICommonsSet<TriggerKey> getTriggerKeys(GroupMatcher<TriggerKey> matcher)
                                                                          throws SchedulerException
```
    Get the names of all the ITriggers in the matching groups.
    
    Specified by:
    
    getTriggerKeys in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getJobDetail
```
public IJobDetail getJobDetail(JobKey jobKey)
                        throws SchedulerException
```
    Get the IJobDetail for the Job instance with the given name and group.
    
    Specified by:
    
    getJobDetail in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getTrigger
```
public ITrigger getTrigger(TriggerKey triggerKey)
                    throws SchedulerException
```
    Get the ITrigger instance with the given name and group.
    
    Specified by:
    
    getTrigger in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - checkExists
```
public boolean checkExists(JobKey jobKey)
                    throws SchedulerException
```
    Determine whether a IJob with the given identifier already exists within the scheduler.
    
    Specified by:
    
    checkExists in interface IQuartzScheduler
    
    Parameters:
    
    jobKey - the identifier to check for
    
    Returns:
    
    true if a Job exists with the given identifier
    
    Throws:
    
    SchedulerException - on error
  - checkExists
```
public boolean checkExists(TriggerKey triggerKey)
                    throws SchedulerException
```
    Determine whether a ITrigger with the given identifier already exists within the scheduler.
    
    Specified by:
    
    checkExists in interface IQuartzScheduler
    
    Parameters:
    
    triggerKey - the identifier to check for
    
    Returns:
    
    true if a Trigger exists with the given identifier
    
    Throws:
    
    SchedulerException - on error
  - clear
```
public void clear()
           throws SchedulerException
```
    Clears (deletes!) all scheduling data - all IJobs, ITriggers ICalendars.
    
    Specified by:
    
    clear in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException - on error
  - getTriggerState
```
public ITrigger.ETriggerState getTriggerState(TriggerKey triggerKey)
                                       throws SchedulerException
```
    Get the current state of the identified ITrigger.
    J *
    
    Specified by:
    
    getTriggerState in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
    
    See Also:
    
    ITrigger.ETriggerState
  - addCalendar
```
public void addCalendar(String calName,
                        ICalendar calendar,
                        boolean replace,
                        boolean updateTriggers)
                 throws SchedulerException
```
    Add (register) the given Calendar to the Scheduler.
    
    Specified by:
    
    addCalendar in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException - if there is an internal Scheduler error, or a Calendar with the same name already exists, and replace is false.
  - deleteCalendar
```
public boolean deleteCalendar(String calName)
                       throws SchedulerException
```
    Delete the identified Calendar from the Scheduler.
    
    Specified by:
    
    deleteCalendar in interface IQuartzScheduler
    
    Returns:
    
    true if the Calendar was found and deleted.
    
    Throws:
    
    SchedulerException - if there is an internal Scheduler error.
  - getCalendar
```
public ICalendar getCalendar(String calName)
                      throws SchedulerException
```
    Get the ICalendar instance with the given name.
    
    Specified by:
    
    getCalendar in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getCalendarNames
```
public com.helger.commons.collection.impl.ICommonsList<String> getCalendarNames()
                                                                         throws SchedulerException
```
    Get the names of all registered ICalendars.
    
    Specified by:
    
    getCalendarNames in interface IQuartzScheduler
    
    Throws:
    
    SchedulerException
  - getListenerManager
```
@Nonnull
public IListenerManager getListenerManager()
```
  - addInternalJobListener
```
public void addInternalJobListener(IJobListener jobListener)
```
    Add the given IJobListener to the Scheduler's internal list.
  - removeInternalJobListener
```
public boolean removeInternalJobListener(String name)
```
    Remove the identified IJobListener from the Scheduler's list of internal listeners.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getInternalJobListeners
```
@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IJobListener> getInternalJobListeners()
```
    Get a List containing all of the IJobListeners in the Scheduler's internal list.
  - getInternalJobListener
```
@Nullable
public IJobListener getInternalJobListener(String name)
```
    Get the internal IJobListener that has the given name.
  - addInternalTriggerListener
```
public void addInternalTriggerListener(ITriggerListener triggerListener)
```
    Add the given ITriggerListener to the Scheduler's internal list.
  - removeinternalTriggerListener
```
public boolean removeinternalTriggerListener(String name)
```
    Remove the identified ITriggerListener from the Scheduler's list of internal listeners.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getInternalTriggerListeners
```
@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<ITriggerListener> getInternalTriggerListeners()
```
    Get a list containing all of the ITriggerListeners in the Scheduler's internal list.
  - getInternalTriggerListener
```
@Nullable
public ITriggerListener getInternalTriggerListener(String name)
```
    Get the internal ITriggerListener that has the given name.
  - addInternalSchedulerListener
```
public void addInternalSchedulerListener(ISchedulerListener schedulerListener)
```
    Register the given ISchedulerListener with the Scheduler's list of internal listeners.
  - removeInternalSchedulerListener
```
public boolean removeInternalSchedulerListener(ISchedulerListener schedulerListener)
```
    Remove the given ISchedulerListener from the Scheduler's list of internal listeners.
    
    Returns:
    
    true if the identified listener was found in the list, and removed.
  - getInternalSchedulerListeners
```
public com.helger.commons.collection.impl.ICommonsList<ISchedulerListener> getInternalSchedulerListeners()
```
    Get a List containing all of the internal ISchedulerListeners registered with the Scheduler.
  - notifyJobStoreJobComplete
```
protected void notifyJobStoreJobComplete(IOperableTrigger trigger,
                                         IJobDetail detail,
                                         ITrigger.ECompletedExecutionInstruction instCode)
```
  - notifyJobStoreJobVetoed
```
protected void notifyJobStoreJobVetoed(IOperableTrigger trigger,
                                       IJobDetail detail,
                                       ITrigger.ECompletedExecutionInstruction instCode)
```
  - notifySchedulerThread
```
protected void notifySchedulerThread(long candidateNewNextFireTime)
```
  - notifyTriggerListenersFired
```
public boolean notifyTriggerListenersFired(IJobExecutionContext jec)
                                    throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifyTriggerListenersMisfired
```
public void notifyTriggerListenersMisfired(ITrigger trigger)
                                    throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifyTriggerListenersComplete
```
public void notifyTriggerListenersComplete(IJobExecutionContext jec,
                                           ITrigger.ECompletedExecutionInstruction instCode)
                                    throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifyJobListenersToBeExecuted
```
public void notifyJobListenersToBeExecuted(IJobExecutionContext jec)
                                    throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifyJobListenersWasVetoed
```
public void notifyJobListenersWasVetoed(IJobExecutionContext jec)
                                 throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifyJobListenersWasExecuted
```
public void notifyJobListenersWasExecuted(IJobExecutionContext jec,
                                          JobExecutionException je)
                                   throws SchedulerException
```
    Throws:
    
    SchedulerException
  - notifySchedulerListenersError
```
public void notifySchedulerListenersError(String msg,
                                          SchedulerException se)
```
  - notifySchedulerListenersSchduled
```
public void notifySchedulerListenersSchduled(ITrigger trigger)
```
  - notifySchedulerListenersUnscheduled
```
public void notifySchedulerListenersUnscheduled(TriggerKey triggerKey)
```
  - notifySchedulerListenersFinalized
```
public void notifySchedulerListenersFinalized(ITrigger trigger)
```
  - notifySchedulerListenersPausedTrigger
```
public void notifySchedulerListenersPausedTrigger(TriggerKey triggerKey)
```
  - notifySchedulerListenersPausedTriggers
```
public void notifySchedulerListenersPausedTriggers(String group)
```
  - notifySchedulerListenersResumedTrigger
```
public void notifySchedulerListenersResumedTrigger(TriggerKey key)
```
  - notifySchedulerListenersResumedTriggers
```
public void notifySchedulerListenersResumedTriggers(String group)
```
  - notifySchedulerListenersPausedJob
```
public void notifySchedulerListenersPausedJob(JobKey key)
```
  - notifySchedulerListenersPausedJobs
```
public void notifySchedulerListenersPausedJobs(String group)
```
  - notifySchedulerListenersResumedJob
```
public void notifySchedulerListenersResumedJob(JobKey key)
```
  - notifySchedulerListenersResumedJobs
```
public void notifySchedulerListenersResumedJobs(String group)
```
  - notifySchedulerListenersInStandbyMode
```
public void notifySchedulerListenersInStandbyMode()
```
  - notifySchedulerListenersStarted
```
public void notifySchedulerListenersStarted()
```
  - notifySchedulerListenersStarting
```
public void notifySchedulerListenersStarting()
```
  - notifySchedulerListenersShutdown
```
public void notifySchedulerListenersShutdown()
```
  - notifySchedulerListenersShuttingdown
```
public void notifySchedulerListenersShuttingdown()
```
  - notifySchedulerListenersJobAdded
```
public void notifySchedulerListenersJobAdded(IJobDetail jobDetail)
```
  - notifySchedulerListenersJobDeleted
```
public void notifySchedulerListenersJobDeleted(JobKey jobKey)
```
  - setJobFactory
```
public void setJobFactory(IJobFactory aFactory)
                   throws SchedulerException
```
    Parameters:
    
    aFactory - Factory. May not be null
    
    Throws:
    
    SchedulerException - on error
  - getJobFactory
```
public IJobFactory getJobFactory()
```
  - interrupt
```
public boolean interrupt(JobKey jobKey)
                  throws UnableToInterruptJobException
```
    Interrupt all instances of the identified InterruptableJob executing in this Scheduler instance.
    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.
    
    Specified by:
    
    interrupt in interface IQuartzScheduler
    
    Throws:
    
    UnableToInterruptJobException
    
    See Also:
    
    IQuartzScheduler.interrupt(JobKey)
  - interrupt
```
public boolean interrupt(String fireInstanceId)
                  throws UnableToInterruptJobException
```
    Interrupt the identified InterruptableJob executing in this Scheduler instance.
    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.
    
    Specified by:
    
    interrupt in interface IQuartzScheduler
    
    Throws:
    
    UnableToInterruptJobException
    
    See Also:
    
    IQuartzScheduler.interrupt(JobKey)

Class QuartzScheduler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QuartzScheduler

Method Detail

initialize

getVersion

getVersionMajor

getVersionMinor

getVersionIteration

getSchedulerSignaler

getSchedulerName

getSchedulerInstanceId

getSchedulerThreadGroup

addNoGCObject

removeNoGCObject

getSchedulerContext

isSignalOnSchedulingChange

setSignalOnSchedulingChange

start

startDelayed

standby

isInStandbyMode

runningSince

numJobsExecuted

getJobStoreClass

supportsPersistence

isClustered

getThreadPoolClass

getThreadPoolSize

shutdown

shutdown

isShutdown

isShuttingDown

isStarted

validateState

getCurrentlyExecutingJobs

scheduleJob

scheduleJob

addJob

addJob

deleteJob

deleteJobs

scheduleJobs

scheduleJob

unscheduleJobs

unscheduleJob

rescheduleJob

triggerJob

triggerJob

pauseTrigger

pauseTriggers

pauseJob

pauseJobs

resumeTrigger

resumeTriggers

getPausedTriggerGroups

resumeJob

resumeJobs

pauseAll

resumeAll

getJobGroupNames

getJobKeys

getTriggersOfJob

getTriggerGroupNames

getTriggerKeys

getJobDetail

getTrigger

checkExists

checkExists

clear

getTriggerState

addCalendar

deleteCalendar

getCalendar

getCalendarNames

getListenerManager

addInternalJobListener