org.quartz.plugins.xml

Class XMLSchedulingDataProcessor

java.lang.Object

org.quartz.plugins.xml.XMLSchedulingDataProcessor

All Implemented Interfaces:

ErrorHandler

public class XMLSchedulingDataProcessor
extends Object
implements ErrorHandler

Parses an XML file that declares Jobs and their schedules (Triggers), and processes the related data.

Since:

Quartz 1.8

Author:

James House, Past contributions from Chris Bonham, Past contributions from pl47ypus, timmolter

Field Summary

Fields

Modifier and Type	Field and Description
static String	QUARTZ_XML_DEFAULT_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
XMLSchedulingDataProcessor(ClassLoadHelper classLoadHelper) Constructor for JobSchedulingDataLoader.

Method Summary

Modifier and Type	Method and Description
void	error(SAXParseException e) ErrorHandler interface.
void	fatalError(SAXParseException e) ErrorHandler interface.
protected Boolean	getBoolean(XPath xpathToElement, String elementName, Node parentNode)
void	processFile(String fileName, boolean failOnFileNotFound) Process the xml file in the given location, and schedule all of the jobs defined within it.
void	scheduleJobs(Scheduler sched) Schedules the given sets of jobs and triggers.
void	warning(SAXParseException e) ErrorHandler interface.

Methods inherited from class java.lang.Object

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

Field Detail

QUARTZ_XML_DEFAULT_FILE_NAME

public static final String QUARTZ_XML_DEFAULT_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

XMLSchedulingDataProcessor

public XMLSchedulingDataProcessor(ClassLoadHelper classLoadHelper)
                           throws ParserConfigurationException

Constructor for JobSchedulingDataLoader.

Parameters:

classLoadHelper -

clh - class-loader helper to share with digester.

Throws:

ParserConfigurationException - if the XML parser cannot be configured as needed.

Method Detail

processFile

public void processFile(String fileName,
                        boolean failOnFileNotFound)
                 throws Exception

Process the xml file in the given location, and schedule all of the jobs defined within it.

Parameters:

fileName - meta data file name.

Throws:

Exception

getBoolean

protected Boolean getBoolean(XPath xpathToElement,
                             String elementName,
                             Node parentNode)
                      throws XPathExpressionException

Throws:

XPathExpressionException

scheduleJobs

public void scheduleJobs(Scheduler sched)
                  throws SchedulerException

Schedules the given sets of jobs and triggers.

Parameters:

sched - job scheduler.

Throws:

SchedulerException - if the Job or Trigger cannot be added to the Scheduler, or there is an internal Scheduler error.

warning

public void warning(SAXParseException e)
             throws SAXException

ErrorHandler interface. Receive notification of a warning.

Specified by:

warning in interface ErrorHandler

Parameters:

e - The error information encapsulated in a SAX parse exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

error

public void error(SAXParseException e)
           throws SAXException

ErrorHandler interface. Receive notification of a recoverable error.

Specified by:

error in interface ErrorHandler

Parameters:

e - The error information encapsulated in a SAX parse exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

ErrorHandler interface. Receive notification of a non-recoverable error.

Specified by:

fatalError in interface ErrorHandler

Parameters:

e - The error information encapsulated in a SAX parse exception.

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.