public class CronTriggerFactoryBean extends java.lang.Object implements FactoryBean<CronTrigger>, BeanNameAware, InitializingBean
FactoryBean
for creating a Quartz org.quartz.CronTrigger
instance, supporting bean-style usage for trigger configuration.
CronTrigger(Impl)
itself is already a JavaBean but lacks sensible defaults.
This class uses the Spring bean name as job name, the Quartz default group ("DEFAULT")
as job group, the current time as start time, and indefinite repetition, if not specified.
This class will also register the trigger with the job name and group of
a given org.quartz.JobDetail
. This allows SchedulerFactoryBean
to automatically register a trigger for the corresponding JobDetail,
instead of registering the JobDetail separately.
setName(java.lang.String)
,
setGroup(java.lang.String)
,
setStartDelay(long)
,
setJobDetail(JobDetail)
,
SchedulerAccessor.setTriggers(Trigger...)
,
SchedulerAccessor.setJobDetails(JobDetail...)
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
beanName |
private java.lang.String |
calendarName |
private static Constants |
constants
Constants for the CronTrigger class.
|
private java.lang.String |
cronExpression |
private CronTrigger |
cronTrigger |
private java.lang.String |
description |
private java.lang.String |
group |
private JobDataMap |
jobDataMap |
private JobDetail |
jobDetail |
private int |
misfireInstruction |
private java.lang.String |
name |
private int |
priority |
private long |
startDelay |
private java.util.Date |
startTime |
private java.util.TimeZone |
timeZone |
Constructor and Description |
---|
CronTriggerFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Invoked by the containing
BeanFactory after it has set all bean properties
and satisfied BeanFactoryAware , ApplicationContextAware etc. |
JobDataMap |
getJobDataMap()
Return the trigger's JobDataMap.
|
CronTrigger |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
java.lang.Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
void |
setBeanName(java.lang.String beanName)
Set the name of the bean in the bean factory that created this bean.
|
void |
setCalendarName(java.lang.String calendarName)
Associate a specific calendar with this cron trigger.
|
void |
setCronExpression(java.lang.String cronExpression)
Specify the cron expression for this trigger.
|
void |
setDescription(java.lang.String description)
Associate a textual description with this trigger.
|
void |
setGroup(java.lang.String group)
Specify the trigger's group.
|
void |
setJobDataAsMap(java.util.Map<java.lang.String,?> jobDataAsMap)
Register objects in the JobDataMap via a given Map.
|
void |
setJobDataMap(JobDataMap jobDataMap)
Set the trigger's JobDataMap.
|
void |
setJobDetail(JobDetail jobDetail)
Set the JobDetail that this trigger should be associated with.
|
void |
setMisfireInstruction(int misfireInstruction)
Specify a misfire instruction for this trigger.
|
void |
setMisfireInstructionName(java.lang.String constantName)
Set the misfire instruction via the name of the corresponding
constant in the
org.quartz.CronTrigger class. |
void |
setName(java.lang.String name)
Specify the trigger's name.
|
void |
setPriority(int priority)
Specify the priority of this trigger.
|
void |
setStartDelay(long startDelay)
Set the start delay in milliseconds.
|
void |
setStartTime(java.util.Date startTime)
Set a specific start time for the trigger.
|
void |
setTimeZone(java.util.TimeZone timeZone)
Specify the time zone for this trigger's cron expression.
|
private static final Constants constants
@Nullable private java.lang.String name
@Nullable private java.lang.String group
@Nullable private JobDetail jobDetail
private JobDataMap jobDataMap
@Nullable private java.util.Date startTime
private long startDelay
@Nullable private java.lang.String cronExpression
@Nullable private java.util.TimeZone timeZone
@Nullable private java.lang.String calendarName
private int priority
private int misfireInstruction
@Nullable private java.lang.String description
@Nullable private java.lang.String beanName
@Nullable private CronTrigger cronTrigger
public void setName(java.lang.String name)
public void setGroup(java.lang.String group)
public void setJobDetail(JobDetail jobDetail)
public void setJobDataMap(JobDataMap jobDataMap)
public JobDataMap getJobDataMap()
public void setJobDataAsMap(java.util.Map<java.lang.String,?> jobDataAsMap)
These objects will be available to this Trigger only, in contrast to objects in the JobDetail's data map.
jobDataAsMap
- a Map with String keys and any objects as values
(for example Spring-managed beans)public void setStartTime(java.util.Date startTime)
Note that a dynamically computed setStartDelay(long)
specification
overrides a static timestamp set here.
public void setStartDelay(long startDelay)
The start delay is added to the current system time (when the bean starts) to control the start time of the trigger.
public void setCronExpression(java.lang.String cronExpression)
public void setTimeZone(java.util.TimeZone timeZone)
public void setCalendarName(java.lang.String calendarName)
public void setPriority(int priority)
public void setMisfireInstruction(int misfireInstruction)
public void setMisfireInstructionName(java.lang.String constantName)
org.quartz.CronTrigger
class.
Default is MISFIRE_INSTRUCTION_SMART_POLICY
.org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW
,
org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING
,
org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY
public void setDescription(java.lang.String description)
public void setBeanName(java.lang.String beanName)
BeanNameAware
Invoked after population of normal bean properties but before an
init callback such as InitializingBean.afterPropertiesSet()
or a custom init-method.
setBeanName
in interface BeanNameAware
beanName
- the name of the bean in the factory.
Note that this name is the actual bean name used in the factory, which may
differ from the originally specified name: in particular for inner bean
names, the actual bean name might have been made unique through appending
"#..." suffixes. Use the BeanFactoryUtils.originalBeanName(String)
method to extract the original bean name (without suffix), if desired.public void afterPropertiesSet() throws java.text.ParseException
InitializingBean
BeanFactory
after it has set all bean properties
and satisfied BeanFactoryAware
, ApplicationContextAware
etc.
This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
afterPropertiesSet
in interface InitializingBean
java.text.ParseException
@Nullable public CronTrigger getObject()
FactoryBean
As with a BeanFactory
, this allows support for both the
Singleton and Prototype design pattern.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding FactoryBeanNotInitializedException
.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
getObject
in interface FactoryBean<CronTrigger>
null
)FactoryBeanNotInitializedException
public java.lang.Class<?> getObjectType()
FactoryBean
null
if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null
here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
getObjectType
in interface FactoryBean<CronTrigger>
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)
public boolean isSingleton()
FactoryBean
FactoryBean.getObject()
always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject()
might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
The default implementation returns true
, since a
FactoryBean
typically manages a singleton instance.
isSingleton
in interface FactoryBean<CronTrigger>
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()