QuartzScheduler MembersQuartz.NET API Documentation

The QuartzScheduler type exposes the following members.

Constructors

  NameDescription
Public methodQuartzScheduler
Create a QuartzScheduler with the given configuration properties.
Top
Methods

  NameDescription
Public methodAddCalendar
Add (register) the given ICalendar to the Scheduler.
Public methodAddInternalJobListener
Add the given IJobListener to the IScheduler's internal list.
Public methodAddInternalSchedulerListener
Register the given ISchedulerListener with the IScheduler's list of internal listeners.
Public methodAddInternalTriggerListener
Add the given ITriggerListener to the IScheduler's internal list.
Public methodAddJob(IJobDetail, Boolean)
Add the given IJob to the Scheduler - with no associated ITrigger. The IJob will be 'dormant' until it is scheduled with a ITrigger, or TriggerJob(JobKey) is called for it.

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

Public methodAddJob(IJobDetail, Boolean, Boolean)
Public methodAddNoGCObject
Adds an object that should be kept as reference to prevent it from being garbage collected.
Public methodCheckExists(JobKey)
Determine whether a IJob with the given identifier already exists within the scheduler.
Public methodCheckExists(TriggerKey)
Determine whether a ITrigger with the given identifier already exists within the scheduler.
Public methodClear
Clears (deletes!) all scheduling data - all IJobs, ITriggers ICalendars.
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDeleteCalendar
Delete the identified ICalendar from the Scheduler.
Public methodDeleteJob
Delete the identified IJob from the Scheduler - and any associated ITriggers.
Public methodDeleteJobs
Public methodDispose 
Releases all resources used by the QuartzScheduler
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the QuartzScheduler and optionally releases the managed resources
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCalendar
Get the ICalendar instance with the given name.
Public methodGetCalendarNames
Get the names of all registered ICalendars.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetInternalJobListener
Get the internalIJobListener that has the given name.
Public methodGetInternalTriggerListener
Get the internalITriggerListener that has the given name.
Public methodGetJobDetail
Get the IJobDetail for the IJob instance with the given name and group.
Public methodGetJobGroupNames
Get the names of all known IJob groups.
Public methodGetJobKeys
Get the names of all the IJobs in the given group.
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetPausedTriggerGroups
Gets the paused trigger groups.
Public methodGetTrigger
Get the ITrigger instance with the given name and group.
Public methodGetTriggerGroupNames
Get the names of all known ITrigger groups.
Public methodGetTriggerKeys
Get the names of all the ITriggers in the matching groups.
Public methodGetTriggersOfJob
Get all ITrigger s that are associated with the identified IJobDetail.
Public methodGetTriggerState
Get the current state of the identified ITrigger.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Overrides MarshalByRefObject InitializeLifetimeService .)
Public methodInterrupt(String)
Interrupt all instances of the identified InterruptableJob executing in this Scheduler instance.
Public methodInterrupt(JobKey)
Interrupt all instances of the identified InterruptableJob.
Public methodIsJobGroupPaused
Public methodIsTriggerGroupPaused
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodStatic memberNextLong
Creates a new positive random number
Public methodNotifyJobListenersToBeExecuted
Notifies the job listeners about job to be executed.
Public methodNotifyJobListenersWasExecuted
Notifies the job listeners that job was executed.
Public methodNotifyJobListenersWasVetoed
Notifies the job listeners that job exucution was vetoed.
Protected methodNotifyJobStoreJobComplete
Notifies the job store job complete.
Protected methodNotifyJobStoreJobVetoed
Public methodNotifySchedulerListenersError
Notifies the scheduler listeners about scheduler error.
Public methodNotifySchedulerListenersFinalized
Notifies the scheduler listeners about finalized trigger.
Public methodNotifySchedulerListenersInStandbyMode
Public methodNotifySchedulerListenersJobAdded
Public methodNotifySchedulerListenersJobDeleted
Public methodNotifySchedulerListenersPausedJob
Notifies the scheduler listeners about paused job.
Public methodNotifySchedulerListenersPausedJobs
Notifies the scheduler listeners about paused job.
Public methodNotifySchedulerListenersPausedTrigger
Notifies the scheduler listeners about paused trigger.
Public methodNotifySchedulerListenersPausedTriggers
Notifies the scheduler listeners about paused trigger.
Public methodNotifySchedulerListenersResumedJob
Notifies the scheduler listeners about resumed job.
Public methodNotifySchedulerListenersResumedJobs
Notifies the scheduler listeners about resumed job.
Public methodNotifySchedulerListenersResumedTrigger
Notifies the scheduler listeners resumed trigger.
Public methodNotifySchedulerListenersResumedTriggers
Notifies the scheduler listeners resumed trigger.
Public methodNotifySchedulerListenersScheduled
Notifies the scheduler listeners about job that was scheduled.
Public methodNotifySchedulerListenersShutdown
Notifies the scheduler listeners about scheduler shutdown.
Public methodNotifySchedulerListenersShuttingdown
Public methodNotifySchedulerListenersStarted
Public methodNotifySchedulerListenersStarting
Public methodNotifySchedulerListenersUnscheduled
Notifies the scheduler listeners about job that was unscheduled.
Protected methodNotifySchedulerThread
Notifies the scheduler thread.
Public methodNotifyTriggerListenersComplete
Notifies the trigger listeners of completion.
Public methodNotifyTriggerListenersFired
Notifies the trigger listeners about fired trigger.
Public methodNotifyTriggerListenersMisfired
Notifies the trigger listeners about misfired trigger.
Public methodPauseAll
Public methodPauseJob
Pause the IJobDetail with the given name - by pausing all of its current ITriggers.
Public methodPauseJobs
Pause all of the IJobDetails in the given group - by pausing all of their ITriggers.
Public methodPauseTrigger
Pause the ITrigger with the given name.
Public methodPauseTriggers
Pause all of the ITriggers in the given group.
Public methodRemoveInternalJobListener
Remove the identified IJobListener from the IScheduler's list of internal listeners.
Public methodRemoveInternalSchedulerListener
Remove the given ISchedulerListener from the IScheduler's list of internal listeners.
Public methodRemoveinternalTriggerListener
Remove the identified ITriggerListener from the IScheduler's list of internal listeners.
Public methodRemoveNoGCObject
Removes the object from garbae collection protected list.
Public methodRescheduleJob
Remove (delete) the ITrigger with the given name, and store the new given one - which must be associated with the same job.
Public methodResumeAll
Resume (un-pause) all triggers - equivalent of calling ResumeTriggers(GroupMatcher TriggerKey ) on every group.

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

Public methodResumeJob
Resume (un-pause) the IJobDetail with the given name.

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

Public methodResumeJobs
Resume (un-pause) all of the IJobDetails in the matching groups.

If any of the IJob s had ITrigger s that missed one or more fire-times, then the ITrigger's misfire instruction will be applied.

Public methodResumeTrigger
Resume (un-pause) the ITrigger with the given name.

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

Public methodResumeTriggers
Resume (un-pause) all of the ITriggers in the matching groups.

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

Public methodScheduleJob(ITrigger)
Schedule the given ITrigger with the IJob identified by the ITrigger's settings.
Public methodScheduleJob(IJobDetail, ITrigger)
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 IJob, then it will be set to reference the Job passed with it into this method.

Public methodScheduleJob(IJobDetail, ISet ITrigger , Boolean)
Public methodScheduleJobs
Public methodShutdown 
Halts the QuartzScheduler's firing of ITriggers, and cleans up all resources associated with the QuartzScheduler. Equivalent to Shutdown(Boolean).

The scheduler cannot be re-started.

Public methodShutdown(Boolean)
Halts the QuartzScheduler's firing of ITriggers, and cleans up all resources associated with the QuartzScheduler.

The scheduler cannot be re-started.

Public methodStandby
Temporarily halts the QuartzScheduler's firing of ITriggers.

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

Public methodStart
Starts the QuartzScheduler's threads that fire ITriggers.

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

Public methodStartDelayed
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodTriggerJob(IOperableTrigger)
Store and schedule the identified IOperableTrigger
Public methodTriggerJob(JobKey, JobDataMap)
Trigger the identified IJob (Execute it now) - with a non-volatile trigger.
Public methodUnscheduleJob
Remove the indicated ITrigger from the scheduler.
Public methodUnscheduleJobs
Public methodValidateState
Validates the state.
Top
Properties

  NameDescription
Public propertyClustered
Public propertyCurrentlyExecutingJobs
Return a list of IJobExecutionContext 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.

Public propertyInStandbyMode
Reports whether the IScheduler is paused.
Public propertyInternalJobListeners
Get a List containing all of the IJobListeners in the IScheduler's internal list.
Public propertyInternalSchedulerListeners
Get a List containing all of the internalISchedulerListeners registered with the IScheduler.
Public propertyInternalTriggerListeners
Get a list containing all of the ITriggerListeners in the IScheduler's internal list.
Public propertyIsShutdown
Reports whether the IScheduler has been Shutdown.
Public propertyIsShuttingDown
Public propertyIsStarted
Public propertyJobFactory
Gets or sets the job factory.
Public propertyJobStoreClass
Gets the job store class.
Public propertyListenerManager
Public propertyNumJobsExecuted
Gets the number of jobs executed.
Public propertyRunningSince
Gets the running since.
Public propertySchedulerContext
Returns the SchedulerContext of the IScheduler.
Public propertySchedulerInstanceId
Returns the instance Id of the QuartzScheduler.
Public propertySchedulerName
Returns the name of the QuartzScheduler.
Public propertySchedulerSignaler
Gets the scheduler signaler.
Public propertySignalOnSchedulingChange
Gets or sets a value indicating whether to signal on scheduling change.
Public propertySupportsPersistence
Gets a value indicating whether this scheduler supports persistence.
Public propertyThreadPoolClass
Gets the thread pool class.
Public propertyThreadPoolSize
Gets the size of the thread pool.
Public propertyVersion
Gets the version of the Quartz Scheduler.
Public propertyStatic memberVersionIteration
Gets the version iteration.
Public propertyStatic memberVersionMajor
Gets the version major.
Public propertyStatic memberVersionMinor
Gets the version minor.
Top
See Also