org.quartz.plugins.xml

Class XMLSchedulingDataProcessorPlugin

java.lang.Object

org.quartz.plugins.xml.XMLSchedulingDataProcessorPlugin

All Implemented Interfaces:

SchedulerPlugin

public class XMLSchedulingDataProcessorPlugin
extends Object
implements SchedulerPlugin

This plugin loads XML file(s) to add jobs and schedule them with triggers as the scheduler is initialized, and can optionally periodically scan the file for changes.

Author:

James House, Pierre Awaragi, pl47ypus

Constructor Summary

Constructors

Constructor and Description
XMLSchedulingDataProcessorPlugin() Constructor

Method Summary

Modifier and Type	Method and Description
String	getFileNames() Comma separated list of file names (with paths) to the XML files that should be read.
long	getScanInterval() The interval (in seconds) at which to scan for changes to the file.
void	initialize(String name, Scheduler scheduler) Called during creation of the Scheduler in order to give the SchedulerPlugin a chance to initialize.
boolean	isFailOnFileNotFound() Whether or not initialization of the plugin should fail (throw an exception) if the file cannot be found.
void	setFailOnFileNotFound(boolean failOnFileNotFound) Whether or not initialization of the plugin should fail (throw an exception) if the file cannot be found.
void	setScanInterval(long scanInterval) The interval (in seconds) at which to scan for changes to the file.
void	shutdown() Overridden to ignore wrapInUserTransaction because shutdown() does not interact with the Scheduler.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLSchedulingDataProcessorPlugin

public XMLSchedulingDataProcessorPlugin()

Constructor

Parameters:

classLoadHelper -

Method Detail

getFileNames

public String getFileNames()

Comma separated list of file names (with paths) to the XML files that should be read.

getScanInterval

public long getScanInterval()

The interval (in seconds) at which to scan for changes to the file. If the file has been changed, it is re-loaded and parsed. The default value for the interval is 0, which disables scanning.

Returns:

Returns the scanInterval.

setScanInterval

public void setScanInterval(long scanInterval)

The interval (in seconds) at which to scan for changes to the file. If the file has been changed, it is re-loaded and parsed. The default value for the interval is 0, which disables scanning.

Parameters:

scanInterval - The scanInterval to set.

isFailOnFileNotFound

public boolean isFailOnFileNotFound()

Whether or not initialization of the plugin should fail (throw an exception) if the file cannot be found. Default is true.

setFailOnFileNotFound

public void setFailOnFileNotFound(boolean failOnFileNotFound)

Whether or not initialization of the plugin should fail (throw an exception) if the file cannot be found. Default is true.

initialize

public void initialize(String name,
                       Scheduler scheduler)
                throws SchedulerException

Called during creation of the Scheduler in order to give the SchedulerPlugin a chance to initialize.

Specified by:

initialize in interface SchedulerPlugin

Parameters:

name - The name by which the plugin is identified.

scheduler - The scheduler to which the plugin is registered.

Throws:

SchedulerConfigException - if there is an error initializing.

SchedulerException

start

public void start()

Description copied from interface: SchedulerPlugin

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.

Specified by:

start in interface SchedulerPlugin

shutdown

public void shutdown()

Overridden to ignore wrapInUserTransaction because shutdown() does not interact with the Scheduler.

Specified by:

shutdown in interface SchedulerPlugin