org.quartz.xml

Class JobSchedulingDataProcessor

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.quartz.xml.JobSchedulingDataProcessor

All Implemented Interfaces:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class JobSchedulingDataProcessor
extends org.xml.sax.helpers.DefaultHandler

Parses an XML file that declares Jobs and their schedules (Triggers). The xml document must conform to the format defined in "job_scheduling_data_1_5.dtd" or "job_scheduling_data_1_5.xsd" After creating an instance of this class, you should call one of the processFile() functions, after which you may call the getScheduledJobs() function to get a handle to the defined Jobs and Triggers, which can then be scheduled with the Scheduler. Alternatively, you could call the processFileAndScheduleJobs() function to do all of this in one step. The same instance can be used again and again, with the list of defined Jobs being cleared each time you call a processFile method, however a single instance is not thread-safe.

Author:

Chris Bonham, James House, pl47ypus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JobSchedulingDataProcessor.CalendarRuleSet RuleSet for common Calendar tags.
class	JobSchedulingDataProcessor.DateConverter Standard Converter implementation that converts an incoming String into a java.util.Date object, optionally using a default value or throwing a ConversionException if a conversion error occurs.
class	JobSchedulingDataProcessor.MisfireInstructionRule This rule translates the trigger misfire instruction constant name into its corresponding value.
class	JobSchedulingDataProcessor.SimpleConverterRule This rule is needed to fix QUARTZ-153.
class	JobSchedulingDataProcessor.TimeZoneConverter Standard Converter implementation that converts an incoming String into a java.util.TimeZone object throwing a ConversionException if a conversion error occurs.
class	JobSchedulingDataProcessor.TriggerRuleSet RuleSet for common Trigger tags.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	QUARTZ_DTD
static java.lang.String	QUARTZ_NS
static java.lang.String	QUARTZ_PUBLIC_ID
static java.lang.String	QUARTZ_SCHEMA
static java.lang.String	QUARTZ_SYSTEM_ID
static java.lang.String	QUARTZ_SYSTEM_ID_DIR_PROP
static java.lang.String	QUARTZ_SYSTEM_ID_PREFIX
static java.lang.String	QUARTZ_XML_FILE_NAME
static java.lang.String	QUARTZ_XSD

Constructor Summary

Constructors

Constructor and Description
JobSchedulingDataProcessor(ClassLoadHelper clh, boolean validating, boolean validatingSchema) Constructor for QuartzMetaDataProcessor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCalendar(Scheduler sched, CalendarBundle calendarBundle) Adds a calendar.
void	addCalendarToSchedule(CalendarBundle cal)
void	addJobToSchedule(JobSchedulingBundle job)
void	addListenerToSchedule(JobListener listener)
void	error(org.xml.sax.SAXParseException e) ErrorHandler interface.
void	fatalError(org.xml.sax.SAXParseException e) ErrorHandler interface.
boolean	getOverWriteExistingJobs() Returns whether to overwrite existing jobs.
JobSchedulingBundle	getScheduledJob(java.lang.String name) Returns a JobSchedulingBundle for the job name.
java.util.Map	getScheduledJobs() Returns a Map of scheduled jobs.
boolean	getUseContextClassLoader() Returns whether to use the context class loader.
void	processFile() Process the xml file in the default location (a file named "quartz_jobs.xml" in the current working directory).
void	processFile(java.lang.String fileName) Process the xml file named fileName.
void	processFile(java.lang.String fileName, java.lang.String systemId) Process the xmlfile named fileName with the given system ID.
void	processFileAndScheduleJobs(Scheduler sched, boolean overWriteExistingJobs) Process the xml file in the default location, and schedule all of the jobs defined within it.
void	processFileAndScheduleJobs(java.lang.String fileName, Scheduler sched, boolean overWriteExistingJobs) Process the xml file in the given location, and schedule all of the jobs defined within it.
void	processFileAndScheduleJobs(java.lang.String fileName, java.lang.String systemId, Scheduler sched, boolean overWriteExistingJobs) Process the xml file in the given location, and schedule all of the jobs defined within it.
void	processStream(java.io.InputStream stream, java.lang.String systemId) Process the xmlfile named fileName with the given system ID.
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId) EntityResolver interface.
void	scheduleJob(JobSchedulingBundle job) Schedules a given job and trigger (both wrapped by a JobSchedulingBundle).
void	scheduleJob(JobSchedulingBundle job, Scheduler sched, boolean localOverWriteExistingJobs) Schedules a given job and trigger (both wrapped by a JobSchedulingBundle).
void	scheduleJobs(java.util.Map jobBundles, Scheduler sched, boolean overWriteExistingJobs) Add the Jobs and Triggers defined in the given map of JobSchedulingBundle s to the given scheduler.
void	setOverWriteExistingJobs(boolean overWriteExistingJobs) Sets whether to overwrite existing jobs.
void	setUseContextClassLoader(boolean useContextClassLoader) Sets whether to use the context class loader.
void	warning(org.xml.sax.SAXParseException e) ErrorHandler interface.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

QUARTZ_PUBLIC_ID

public static final java.lang.String QUARTZ_PUBLIC_ID

See Also:

Constant Field Values

QUARTZ_SYSTEM_ID

public static final java.lang.String QUARTZ_SYSTEM_ID

See Also:

Constant Field Values

QUARTZ_DTD

public static final java.lang.String QUARTZ_DTD

See Also:

Constant Field Values

QUARTZ_NS

public static final java.lang.String QUARTZ_NS

See Also:

Constant Field Values

QUARTZ_SCHEMA

public static final java.lang.String QUARTZ_SCHEMA

See Also:

Constant Field Values

QUARTZ_XSD

public static final java.lang.String QUARTZ_XSD

See Also:

Constant Field Values

QUARTZ_SYSTEM_ID_DIR_PROP

public static final java.lang.String QUARTZ_SYSTEM_ID_DIR_PROP

See Also:

Constant Field Values

QUARTZ_XML_FILE_NAME

public static final java.lang.String QUARTZ_XML_FILE_NAME

See Also:

Constant Field Values

QUARTZ_SYSTEM_ID_PREFIX

public static final java.lang.String QUARTZ_SYSTEM_ID_PREFIX

See Also:

Constant Field Values

Constructor Detail

JobSchedulingDataProcessor

public JobSchedulingDataProcessor(ClassLoadHelper clh,
                          boolean validating,
                          boolean validatingSchema)

Constructor for QuartzMetaDataProcessor.

Parameters:

clh - class-loader helper to share with digester.

validating - whether or not to validate XML.

validatingSchema - whether or not to validate XML schema.

Method Detail

getUseContextClassLoader

public boolean getUseContextClassLoader()

Returns whether to use the context class loader.

Returns:

whether to use the context class loader.

setUseContextClassLoader

public void setUseContextClassLoader(boolean useContextClassLoader)

Sets whether to use the context class loader.

Parameters:

useContextClassLoader - boolean.

getOverWriteExistingJobs

public boolean getOverWriteExistingJobs()

Returns whether to overwrite existing jobs.

Returns:

whether to overwrite existing jobs.

setOverWriteExistingJobs

public void setOverWriteExistingJobs(boolean overWriteExistingJobs)

Sets whether to overwrite existing jobs.

Parameters:

overWriteExistingJobs - boolean.

processFile

public void processFile()
                 throws java.lang.Exception

Process the xml file in the default location (a file named "quartz_jobs.xml" in the current working directory).

Throws:

java.lang.Exception

processFile

public void processFile(java.lang.String fileName)
                 throws java.lang.Exception

Process the xml file named fileName.

Parameters:

fileName - meta data file name.

Throws:

java.lang.Exception

processFile

public void processFile(java.lang.String fileName,
               java.lang.String systemId)
                 throws ValidationException,
                        javax.xml.parsers.ParserConfigurationException,
                        org.xml.sax.SAXException,
                        java.io.IOException,
                        SchedulerException,
                        java.lang.ClassNotFoundException,
                        java.text.ParseException

Process the xmlfile named fileName with the given system ID.

Parameters:

fileName - meta data file name.

systemId - system ID.

Throws:

ValidationException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

SchedulerException

java.lang.ClassNotFoundException

java.text.ParseException

processStream

public void processStream(java.io.InputStream stream,
                 java.lang.String systemId)
                   throws ValidationException,
                          javax.xml.parsers.ParserConfigurationException,
                          org.xml.sax.SAXException,
                          java.io.IOException,
                          SchedulerException,
                          java.lang.ClassNotFoundException,
                          java.text.ParseException

Process the xmlfile named fileName with the given system ID.

Parameters:

stream - an input stream containing the xml content.

systemId - system ID.

Throws:

ValidationException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

SchedulerException

java.lang.ClassNotFoundException

java.text.ParseException

processFileAndScheduleJobs

public void processFileAndScheduleJobs(Scheduler sched,
                              boolean overWriteExistingJobs)
                                throws SchedulerException,
                                       java.lang.Exception

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

Throws:

SchedulerException

java.lang.Exception

processFileAndScheduleJobs

public void processFileAndScheduleJobs(java.lang.String fileName,
                              Scheduler sched,
                              boolean overWriteExistingJobs)
                                throws java.lang.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:

java.lang.Exception

processFileAndScheduleJobs

public void processFileAndScheduleJobs(java.lang.String fileName,
                              java.lang.String systemId,
                              Scheduler sched,
                              boolean overWriteExistingJobs)
                                throws java.lang.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:

java.lang.Exception

scheduleJobs

public void scheduleJobs(java.util.Map jobBundles,
                Scheduler sched,
                boolean overWriteExistingJobs)
                  throws java.lang.Exception

Add the Jobs and Triggers defined in the given map of JobSchedulingBundle s to the given scheduler.

Parameters:

jobBundles -

sched -

overWriteExistingJobs -

Throws:

java.lang.Exception

getScheduledJobs

public java.util.Map getScheduledJobs()

Returns a Map of scheduled jobs.

The key is the job name and the value is a JobSchedulingBundle containing the JobDetail and Trigger.

Returns:

a Map of scheduled jobs.

getScheduledJob

public JobSchedulingBundle getScheduledJob(java.lang.String name)

Returns a JobSchedulingBundle for the job name.

Parameters:

name - job name.

Returns:

a JobSchedulingBundle for the job name.

scheduleJob

public void scheduleJob(JobSchedulingBundle job)
                 throws SchedulerException

Schedules a given job and trigger (both wrapped by a JobSchedulingBundle).

Parameters:

job - job wrapper.

Throws:

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

addJobToSchedule

public void addJobToSchedule(JobSchedulingBundle job)

addCalendarToSchedule

public void addCalendarToSchedule(CalendarBundle cal)

addListenerToSchedule

public void addListenerToSchedule(JobListener listener)

scheduleJob

public void scheduleJob(JobSchedulingBundle job,
               Scheduler sched,
               boolean localOverWriteExistingJobs)
                 throws SchedulerException

Schedules a given job and trigger (both wrapped by a JobSchedulingBundle).

Parameters:

job - job wrapper.

sched - job scheduler.

localOverWriteExistingJobs - locally overwrite existing jobs.

Throws:

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

addCalendar

public void addCalendar(Scheduler sched,
               CalendarBundle calendarBundle)
                 throws SchedulerException

Adds a calendar.

Parameters:

calendarBundle - calendar bundle.

Throws:

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

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                    java.lang.String systemId)

EntityResolver interface.

Allow the application to resolve external entities.

Until quartz.dtd has a public ID, it must resolved as a system ID. Here's the order of resolution (if one fails, continue to the next).

1. Tries to resolve the systemId with ClassLoader.getResourceAsStream(String).
2. If the systemId starts with QUARTZ_SYSTEM_ID_PREFIX, then resolve the part after QUARTZ_SYSTEM_ID_PREFIX with ClassLoader.getResourceAsStream(String).
3. Else try to resolve systemId as a URL.
4. If systemId has a colon in it, create a new URL
5. Else resolve systemId as a File and then call File.toURL().

If the publicId does exist, resolve it as a URL. If the publicId is the Quartz public ID, then resolve it locally.

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Overrides:

resolveEntity in class org.xml.sax.helpers.DefaultHandler

Parameters:

publicId - The public identifier of the external entity being referenced, or null if none was supplied.

systemId - The system identifier of the external entity being referenced.

Returns:

An InputSource object describing the new input source, or null to request that the parser open a regular URI connection to the system identifier.

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

java.io.IOException - A Java-specific IO exception, possibly the result of creating a new InputStream or Reader for the InputSource.

warning

public void warning(org.xml.sax.SAXParseException e)
             throws org.xml.sax.SAXException

ErrorHandler interface. Receive notification of a warning.

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

warning in class org.xml.sax.helpers.DefaultHandler

Parameters:

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

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

error

public void error(org.xml.sax.SAXParseException e)
           throws org.xml.sax.SAXException

ErrorHandler interface. Receive notification of a recoverable error.

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

error in class org.xml.sax.helpers.DefaultHandler

Parameters:

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

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.

fatalError

public void fatalError(org.xml.sax.SAXParseException e)
                throws org.xml.sax.SAXException

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

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

fatalError in class org.xml.sax.helpers.DefaultHandler

Parameters:

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

Throws:

org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.