org.opensingular.flow.schedule.quartz

Class QuartzSchedulerFactory

java.lang.Object

org.opensingular.flow.schedule.quartz.SchedulerAccessor

org.opensingular.flow.schedule.quartz.QuartzSchedulerFactory

public class QuartzSchedulerFactory
extends SchedulerAccessor

Factory that creates and configures a Quartz Scheduler.

Allows registration of JobDetails, Calendars and Triggers, automatically starting the scheduler on initialization and shutting it down on destruction. In scenarios that just require static registration of jobs at startup, there is no need to access the Scheduler instance itself in application code.

For dynamic registration of jobs at runtime, use a bean reference to this SchedulerFactoryBean to get direct access to the Quartz Scheduler (org.quartz.Scheduler). This allows you to create new jobs and triggers, and also to control and monitor the entire Scheduler.

Note that Quartz instantiates a new Job for each execution, in contrast to Timer which uses a TimerTask instance that is shared between repeated executions. Just JobDetail descriptors are shared.

Author:

Daniel Bordin

See Also:

Scheduler, SchedulerFactory, StdSchedulerFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_THREAD_COUNT The DEFAULT_THREAD_COUNT constant.
static String	PROP_THREAD_COUNT The PROP_THREAD_COUNT constant.

Fields inherited from class org.opensingular.flow.schedule.quartz.SchedulerAccessor

JOB_DETAIL_KEY, logger

Constructor Summary

Constructors

Constructor and Description
QuartzSchedulerFactory()

Method Summary

Modifier and Type	Method and Description
void	addJob(org.quartz.JobDetail jobDetail) Add a job.
void	addTrigger(org.quartz.Trigger trigger) Add trigger and the trigger's job detail.
void	addTrigger(org.quartz.Trigger trigger, org.quartz.JobDetail jobDetail) Add a trigger with the specified job detail.
protected org.quartz.Scheduler	createScheduler(org.quartz.SchedulerFactory schedulerFactory, String schedulerName) Create the Scheduler instance for the given factory and scheduler name.
void	destroy() Shut down the Quartz scheduler on factory shutdown, stopping all scheduled jobs.
org.quartz.Scheduler	getScheduler() Method that determines the Scheduler to operate on.
void	initialize() This method allows the instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
boolean	isRunning() Reports whether the Scheduler is in stand-by mode.
void	setConfigLocation(ResourceBundle configLocation) Set the location of the Quartz properties config file, for example as classpath resource "classpath:quartz.properties".
void	setExposeSchedulerInRepository(boolean exposeSchedulerInRepository) Set whether to expose the Scheduler instance in the Quartz SchedulerRepository.
void	setJobFactory(org.quartz.spi.JobFactory jobFactory) Set the Quartz JobFactory to use for this Scheduler.
void	setQuartzProperties(Properties quartzProperties) Set Quartz properties, like "org.quartz.threadPool.class".
void	setSchedulerFactoryClass(Class<? extends org.quartz.SchedulerFactory> schedulerFactoryClass) Set the Quartz SchedulerFactory implementation to use.
void	setSchedulerName(String schedulerName) Set the name of the Scheduler to create via the SchedulerFactory.
void	setWaitForJobsToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown) Set whether to wait for running jobs to complete on shutdown.
void	start() Start the scheduler immediately.
void	start(int startupDelay) Start the scheduler, respecting the "startupDelay" setting.
protected void	startScheduler(org.quartz.Scheduler scheduler, int startupDelay) Start the Quartz Scheduler, respecting the "startupDelay" setting.
void	stop() Temporarily halts the Scheduler's firing of Triggers.
void	stop(Runnable callback) Call callback.run() after stop().
void	triggerJob(org.quartz.JobKey jobKey) Trigger the identified JobDetail (execute it now).

Methods inherited from class org.opensingular.flow.schedule.quartz.SchedulerAccessor

addJobToScheduler, addTriggerToScheduler, registerJobsAndTriggers, registerListeners, setCalendars, setGlobalJobListeners, setGlobalTriggerListeners, setJobDetails, setJobSchedulingDataLocation, setJobSchedulingDataLocations, setOverwriteExistingJobs, setSchedulerListeners, setTriggers

Methods inherited from class java.lang.Object

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

Field Detail

PROP_THREAD_COUNT

public static final String PROP_THREAD_COUNT

The PROP_THREAD_COUNT constant.

See Also:

Constant Field Values

DEFAULT_THREAD_COUNT

public static final int DEFAULT_THREAD_COUNT

The DEFAULT_THREAD_COUNT constant.

See Also:

Constant Field Values

Constructor Detail

QuartzSchedulerFactory

public QuartzSchedulerFactory()

Method Detail

setSchedulerFactoryClass

public void setSchedulerFactoryClass(Class<? extends org.quartz.SchedulerFactory> schedulerFactoryClass)

Set the Quartz SchedulerFactory implementation to use.

Default is StdSchedulerFactory, reading in the standard quartz.properties from quartz.jar. To use custom Quartz properties, specify the "configLocation" or "quartzProperties" bean property on this FactoryBean.

See Also:

StdSchedulerFactory, setConfigLocation(java.util.ResourceBundle), setQuartzProperties(java.util.Properties)

setSchedulerName

public void setSchedulerName(String schedulerName)

Set the name of the Scheduler to create via the SchedulerFactory.

If not specified, the bean name will be used as default scheduler name.

See Also:

SchedulerFactory.getScheduler(), SchedulerFactory.getScheduler(String)

setConfigLocation

public void setConfigLocation(ResourceBundle configLocation)

Set the location of the Quartz properties config file, for example as classpath resource "classpath:quartz.properties".

Note: Can be omitted when all necessary properties are specified locally via this bean, or when relying on Quartz' default configuration.

See Also:

setQuartzProperties(java.util.Properties)

setQuartzProperties

public void setQuartzProperties(Properties quartzProperties)

Set Quartz properties, like "org.quartz.threadPool.class".

Can be used to override values in a Quartz properties config file, or to specify all necessary properties locally.

See Also:

setConfigLocation(java.util.ResourceBundle)

setJobFactory

public void setJobFactory(org.quartz.spi.JobFactory jobFactory)

Set the Quartz JobFactory to use for this Scheduler.

Default is QuartzJobFactory, which supports IScheduledJob objects as well as standard Quartz Job instances. Note that this default only applies to a local Scheduler, not to a RemoteScheduler (where setting a custom JobFactory is not supported by Quartz).

See Also:

QuartzJobFactory

setExposeSchedulerInRepository

public void setExposeSchedulerInRepository(boolean exposeSchedulerInRepository)

Set whether to expose the Scheduler instance in the Quartz SchedulerRepository. Default is "false", since the Scheduler is usually exclusively intended for access within the context.

Switch this flag to "true" in order to expose the Scheduler globally. This is not recommended unless you have an existing application that relies on this behavior.

setWaitForJobsToCompleteOnShutdown

public void setWaitForJobsToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown)

Set whether to wait for running jobs to complete on shutdown.

Default is "false". Switch this to "true" if you prefer fully completed jobs at the expense of a longer shutdown phase.

See Also:

Scheduler.shutdown(boolean)

initialize

public void initialize()
                throws Exception

This method allows the instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

Throws:

Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

createScheduler

protected org.quartz.Scheduler createScheduler(org.quartz.SchedulerFactory schedulerFactory,
                                               String schedulerName)
                                        throws org.quartz.SchedulerException

Create the Scheduler instance for the given factory and scheduler name. Called by initialize().

The default implementation invokes SchedulerFactory's getScheduler method. Can be overridden for custom Scheduler creation.

Parameters:

schedulerFactory - the factory to create the Scheduler with

schedulerName - the name of the scheduler to create

Returns:

the Scheduler instance

Throws:

org.quartz.SchedulerException - if thrown by Quartz methods

See Also:

initialize(), SchedulerFactory.getScheduler()

startScheduler

protected void startScheduler(org.quartz.Scheduler scheduler,
                              int startupDelay)
                       throws org.quartz.SchedulerException

Start the Quartz Scheduler, respecting the "startupDelay" setting.

Parameters:

scheduler - the Scheduler to start

startupDelay - the number of seconds to wait before starting the Scheduler asynchronously

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

getScheduler

public org.quartz.Scheduler getScheduler()

Method that determines the Scheduler to operate on.

Specified by:

getScheduler in class SchedulerAccessor

start

public void start()
           throws org.quartz.SchedulerException

Start the scheduler immediately.

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

start

public void start(int startupDelay)
           throws org.quartz.SchedulerException

Start the scheduler, respecting the "startupDelay" setting.

Parameters:

startupDelay - the number of seconds to wait before starting

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

stop

public void stop()
          throws org.quartz.SchedulerException

Temporarily halts the Scheduler's firing of Triggers.

When start() is called (to bring the scheduler out of stand-by mode), trigger misfire instructions will NOT be applied during the execution of the start() method - any misfires will be detected immediately afterward (by the JobStore's normal process).

The scheduler is not destroyed, and can be re-started at any time.

Throws:

org.quartz.SchedulerException

See Also:

start()

stop

public void stop(Runnable callback)
          throws org.quartz.SchedulerException

Call callback.run() after stop().

Parameters:

callback - the callback.

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

isRunning

public boolean isRunning()

Reports whether the Scheduler is in stand-by mode.

See Also:

stop(), start()

destroy

public void destroy()
             throws org.quartz.SchedulerException

Shut down the Quartz scheduler on factory shutdown, stopping all scheduled jobs.

Throws:

org.quartz.SchedulerException

addJob

public void addJob(org.quartz.JobDetail jobDetail)
            throws org.quartz.SchedulerException

Add a job.

Parameters:

jobDetail - the job detail.

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

addTrigger

public void addTrigger(org.quartz.Trigger trigger,
                       org.quartz.JobDetail jobDetail)
                throws org.quartz.SchedulerException

Add a trigger with the specified job detail.

Parameters:

trigger - the trigger.

jobDetail - the job detail.

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

addTrigger

public void addTrigger(org.quartz.Trigger trigger)
                throws org.quartz.SchedulerException

Add trigger and the trigger's job detail.

Parameters:

trigger - the trigger.

Throws:

org.quartz.SchedulerException - if could not start Quartz Scheduler.

triggerJob

public void triggerJob(org.quartz.JobKey jobKey)
                throws org.quartz.SchedulerException

Trigger the identified JobDetail (execute it now).

Parameters:

jobKey -

Throws:

org.quartz.SchedulerException