Class SchedulerAccessor
- java.lang.Object
- org.springframework.scheduling.quartz.SchedulerAccessor
- All Implemented Interfaces:
Aware
,ResourceLoaderAware
- Direct Known Subclasses:
SchedulerAccessorBean
,SchedulerFactoryBean
public abstract class SchedulerAccessor extends Object implements ResourceLoaderAware
Common base class for accessing a Quartz Scheduler, i.e. for registering jobs, triggers and listeners on aScheduler
instance.For concrete usage, check out the
SchedulerFactoryBean
andSchedulerAccessorBean
classes.Compatible with Quartz 2.1.4 and higher, as of Spring 4.1.
- Since:
- 2.5.6
- Author:
- Juergen Hoeller, Stephane Nicoll
Field Summary
Fields Modifier and Type Field Description protected Log
logger
protected ResourceLoader
resourceLoader
Constructor Summary
Constructors Constructor Description SchedulerAccessor()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract Scheduler
getScheduler()
Template method that determines the Scheduler to operate on.protected void
registerJobsAndTriggers()
Register jobs and triggers (within a transaction, if possible).protected void
registerListeners()
Register all specified listeners with the Scheduler.void
setCalendars(Map<String,Calendar> calendars)
Register a list of Quartz Calendar objects with the Scheduler that this FactoryBean creates, to be referenced by Triggers.void
setGlobalJobListeners(JobListener... globalJobListeners)
Specify global Quartz JobListeners to be registered with the Scheduler.void
setGlobalTriggerListeners(TriggerListener... globalTriggerListeners)
Specify global Quartz TriggerListeners to be registered with the Scheduler.void
setJobDetails(JobDetail... jobDetails)
Register a list of JobDetail objects with the Scheduler that this FactoryBean creates, to be referenced by Triggers.void
setJobSchedulingDataLocation(String jobSchedulingDataLocation)
Set the location of a Quartz job definition XML file that follows the "job_scheduling_data_1_5" XSD or better.void
setJobSchedulingDataLocations(String... jobSchedulingDataLocations)
Set the locations of Quartz job definition XML files that follow the "job_scheduling_data_1_5" XSD or better.void
setOverwriteExistingJobs(boolean overwriteExistingJobs)
Set whether any jobs defined on this SchedulerFactoryBean should overwrite existing job definitions.void
setResourceLoader(ResourceLoader resourceLoader)
Set the ResourceLoader that this object runs in.void
setSchedulerListeners(SchedulerListener... schedulerListeners)
Specify Quartz SchedulerListeners to be registered with the Scheduler.void
setTransactionManager(PlatformTransactionManager transactionManager)
Set the transaction manager to be used for registering jobs and triggers that are defined by this SchedulerFactoryBean.void
setTriggers(Trigger... triggers)
Register a list of Trigger objects with the Scheduler that this FactoryBean creates.
Field Detail
resourceLoader
@Nullable protected ResourceLoader resourceLoader
Constructor Detail
SchedulerAccessor
public SchedulerAccessor()
Method Detail
setOverwriteExistingJobs
public void setOverwriteExistingJobs(boolean overwriteExistingJobs)
Set whether any jobs defined on this SchedulerFactoryBean should overwrite existing job definitions. Default is "false", to not overwrite already registered jobs that have been read in from a persistent job store.
setJobSchedulingDataLocation
public void setJobSchedulingDataLocation(String jobSchedulingDataLocation)
Set the location of a Quartz job definition XML file that follows the "job_scheduling_data_1_5" XSD or better. Can be specified to automatically register jobs that are defined in such a file, possibly in addition to jobs defined directly on this SchedulerFactoryBean.- See Also:
XMLSchedulingDataProcessor
setJobSchedulingDataLocations
public void setJobSchedulingDataLocations(String... jobSchedulingDataLocations)
Set the locations of Quartz job definition XML files that follow the "job_scheduling_data_1_5" XSD or better. Can be specified to automatically register jobs that are defined in such files, possibly in addition to jobs defined directly on this SchedulerFactoryBean.- See Also:
XMLSchedulingDataProcessor
setJobDetails
public void setJobDetails(JobDetail... jobDetails)
Register a list of JobDetail objects with the Scheduler that this FactoryBean creates, to be referenced by Triggers.This is not necessary when a Trigger determines the JobDetail itself: In this case, the JobDetail will be implicitly registered in combination with the Trigger.
- See Also:
setTriggers(org.quartz.Trigger...)
,JobDetail
setCalendars
public void setCalendars(Map<String,Calendar> calendars)
Register a list of Quartz Calendar objects with the Scheduler that this FactoryBean creates, to be referenced by Triggers.- Parameters:
calendars
- a Map with calendar names as keys as Calendar objects as values- See Also:
Calendar
setTriggers
public void setTriggers(Trigger... triggers)
Register a list of Trigger objects with the Scheduler that this FactoryBean creates.If the Trigger determines the corresponding JobDetail itself, the job will be automatically registered with the Scheduler. Else, the respective JobDetail needs to be registered via the "jobDetails" property of this FactoryBean.
setSchedulerListeners
public void setSchedulerListeners(SchedulerListener... schedulerListeners)
Specify Quartz SchedulerListeners to be registered with the Scheduler.
setGlobalJobListeners
public void setGlobalJobListeners(JobListener... globalJobListeners)
Specify global Quartz JobListeners to be registered with the Scheduler. Such JobListeners will apply to all Jobs in the Scheduler.
setGlobalTriggerListeners
public void setGlobalTriggerListeners(TriggerListener... globalTriggerListeners)
Specify global Quartz TriggerListeners to be registered with the Scheduler. Such TriggerListeners will apply to all Triggers in the Scheduler.
setTransactionManager
public void setTransactionManager(PlatformTransactionManager transactionManager)
Set the transaction manager to be used for registering jobs and triggers that are defined by this SchedulerFactoryBean. Default is none; setting this only makes sense when specifying a DataSource for the Scheduler.
setResourceLoader
public void setResourceLoader(ResourceLoader resourceLoader)
Description copied from interface:ResourceLoaderAware
Set the ResourceLoader that this object runs in.This might be a ResourcePatternResolver, which can be checked through
instanceof ResourcePatternResolver
. See also theResourcePatternUtils.getResourcePatternResolver
method.Invoked after population of normal bean properties but before an init callback like InitializingBean's
afterPropertiesSet
or a custom init-method. Invoked before ApplicationContextAware'ssetApplicationContext
.- Specified by:
setResourceLoader
in interfaceResourceLoaderAware
- Parameters:
resourceLoader
- the ResourceLoader object to be used by this object- See Also:
ResourcePatternResolver
,ResourcePatternUtils.getResourcePatternResolver(org.springframework.core.io.ResourceLoader)
registerJobsAndTriggers
protected void registerJobsAndTriggers() throws SchedulerException
Register jobs and triggers (within a transaction, if possible).- Throws:
SchedulerException
registerListeners
protected void registerListeners() throws SchedulerException
Register all specified listeners with the Scheduler.- Throws:
SchedulerException
getScheduler
protected abstract Scheduler getScheduler()
Template method that determines the Scheduler to operate on. To be implemented by subclasses.