Interface SchedulerPlugin
-
- All Known Implementing Classes:
JobInterruptMonitorPlugin
,LoggingJobHistoryPlugin
,LoggingTriggerHistoryPlugin
,SchedulerPluginWithUserTransactionSupport
,ShutdownHookPlugin
,XMLSchedulingDataProcessorPlugin
public interface SchedulerPlugin
Provides an interface for a class to become a "plugin" to Quartz.
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
JobListener
,TriggerListener
, and/orSchedulerListener
.If you use
to initialize your Scheduler, it can also create and initialize your plugins - look at the configuration docs for details.StdSchedulerFactory
If you need direct access your plugin, you can have it explicitly put a reference to itself in the
Scheduler
'sSchedulerContext
as part of its
method.initialize(String, Scheduler, ClassLoadHelper)
- Author:
- James House
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
initialize(java.lang.String name, Scheduler scheduler, ClassLoadHelper loadHelper)
Called during creation of theScheduler
in order to give theSchedulerPlugin
a chance to initialize.void
shutdown()
Called in order to inform theSchedulerPlugin
that it should free up all of it's resources because the scheduler is shutting down.void
start()
Called when the associatedScheduler
is started, in order to let the plug-in know it can now make calls into the scheduler if it needs to.
-
-
-
Method Detail
-
initialize
void initialize(java.lang.String name, Scheduler scheduler, ClassLoadHelper loadHelper) throws SchedulerException
Called during creation of the
Scheduler
in order to give theSchedulerPlugin
a chance to initialize.At this point, the Scheduler's
JobStore
is not yet initialized.If you need direct access your plugin, for example during
Job
execution, you can have this method explicitly put a reference to this plugin in theScheduler
'sSchedulerContext
.- Parameters:
name
- The name by which the plugin is identified.scheduler
- The scheduler to which the plugin is registered.loadHelper
- The classLoadHelper theSchedulerFactory
is actually using- Throws:
SchedulerConfigException
- if there is an error initializing.SchedulerException
-
start
void start()
Called when the associated
Scheduler
is started, in order to let the plug-in know it can now make calls into the scheduler if it needs to.
-
shutdown
void shutdown()
Called in order to inform the
SchedulerPlugin
that it should free up all of it's resources because the scheduler is shutting down.
-
-