ISchedulerPlugin Interface

Quartz.NET 3.0 API Documentation
Provides an interface for a class to become a "plugin" to Quartz.

Namespace:  Quartz.Spi
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
public interface ISchedulerPlugin

The ISchedulerPlugin type exposes the following members.

Methods

  NameDescription
Public methodInitialize
Called during creation of the IScheduler in order to give the ISchedulerPlugin a chance to Initialize.
Public methodShutdown
Called in order to inform the ISchedulerPlugin that it should free up all of it's resources because the scheduler is shutting down.
Public methodStart
Called when the associated IScheduler is started, in order to let the plug-in know it can now make calls into the scheduler if it needs to.
Top
Remarks

Plugins can do virtually anything you wish, though the most interesting ones will obviously interact with the scheduler in some way - either actively: by invoking actions on the scheduler, or passively: by being a IJobListener, ITriggerListener, and/or ISchedulerListener.

If you use StdSchedulerFactory to Initialize your Scheduler, it can also create and Initialize your plugins - look at the configuration docs for details.

If you need direct access your plugin, you can have it explicitly put a reference to itself in the IScheduler's SchedulerContext as part of its Initialize(String, IScheduler, CancellationToken) method.

See Also

Reference