Spring Framework 6.1.4 · org.springframework.scheduling.quartz.CronTriggerFactoryBean

Modifier and Type	Field and Description
private String	beanName
private String	calendarName
private static final Map<String, Integer>	constants Map of constant names to constant values for the misfire instruction constants defined in `org.quartz.Trigger` and `org.quartz.CronTrigger`.
private String	cronExpression
private org.quartz.CronTrigger	cronTrigger
private String	description
private String	group
private org.quartz.JobDataMap	jobDataMap
private org.quartz.JobDetail	jobDetail
private int	misfireInstruction
private String	name
private int	priority
private long	startDelay
private Date	startTime
private TimeZone	timeZone

Access	Constructor and Description
public	CronTriggerFactoryBean()

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `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.
public org.quartz.JobDataMap	getJobDataMap() Return the trigger's JobDataMap.
public org.quartz.CronTrigger	getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory.
public Class<?>	getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `null` if not known in advance.
public boolean	isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton?
public void	setBeanName(String 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. beanName) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean.
public void	setCalendarName(String calendarName) Associate a specific calendar with this cron trigger.
public void	setCronExpression(String cronExpression) Specify the cron expression for this trigger.
public void	setDescription(String description) Associate a textual description with this trigger.
public void	setGroup(String group) Specify the trigger's group.
public void	setJobDataAsMap(Map<String, ?> a Map with String keys and any objects as values (for example Spring-managed beans) jobDataAsMap) Register objects in the JobDataMap via a given Map.
public void	setJobDataMap(org.quartz.JobDataMap jobDataMap) Set the trigger's JobDataMap.
public void	setJobDetail(org.quartz.JobDetail jobDetail) Set the JobDetail that this trigger should be associated with.
public void	setMisfireInstruction(int misfireInstruction) Specify the misfire instruction for this trigger.
public void	setMisfireInstructionName(String constantName) Set the misfire instruction for this trigger via the name of the corresponding constant in the `org.quartz.Trigger` and `org.quartz.CronTrigger` classes.
public void	setName(String name) Specify the trigger's name.
public void	setPriority(int priority) Specify the priority of this trigger.
public void	setStartDelay(long startDelay) Set the start delay in milliseconds.
public void	setStartTime(Date startTime) Set a specific start time for the trigger.
public void	setTimeZone(TimeZone timeZone) Specify the time zone for this trigger's cron expression.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

beanName	back to summary
private String beanName Annotations @Nullable

calendarName	back to summary
private String calendarName Annotations @Nullable

constants	back to summary
private static final Map<String, Integer> constants Map of constant names to constant values for the misfire instruction constants defined in `org.quartz.Trigger` and `org.quartz.CronTrigger`.

cronExpression	back to summary
private String cronExpression Annotations @Nullable

cronTrigger	back to summary
private org.quartz.CronTrigger cronTrigger Annotations @Nullable

description	back to summary
private String description Annotations @Nullable

group	back to summary
private String group Annotations @Nullable

jobDataMap	back to summary
private org.quartz.JobDataMap jobDataMap

jobDetail	back to summary
private org.quartz.JobDetail jobDetail Annotations @Nullable

misfireInstruction	back to summary
private int misfireInstruction

name	back to summary
private String name Annotations @Nullable

priority	back to summary
private int priority

startDelay	back to summary
private long startDelay

startTime	back to summary
private Date startTime Annotations @Nullable

timeZone	back to summary
private TimeZone timeZone Annotations @Nullable

CronTriggerFactoryBean	back to summary
public CronTriggerFactoryBean()

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws ParseException Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `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. Annotations @Override

public void afterPropertiesSet() throws ParseException

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing 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.

Annotations

@Override

getJobDataMap	back to summary
public org.quartz.JobDataMap getJobDataMap() Return the trigger's JobDataMap.

getObject back to summary

getObject	back to summary
public org.quartz.CronTrigger getObject() Implements org.springframework.beans.factory.FactoryBean.getObject. Doc from org.springframework.beans.factory.FactoryBean.getObject. Return an instance (possibly shared or independent) of the object managed by this factory. 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. Returns:org.quartz.CronTrigger an instance of the bean (can be `null`) Annotations @Override @Nullable

public org.quartz.CronTrigger getObject()

Implements org.springframework.beans.factory.FactoryBean.getObject.

Doc from org.springframework.beans.factory.FactoryBean.getObject.

Return an instance (possibly shared or independent) of the object managed by this factory.

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.

Returns:org.quartz.CronTrigger

an instance of the bean (can be null)

Annotations

@Override
@Nullable

getObjectType back to summary

getObjectType	back to summary
public Class<?> getObjectType() Implements org.springframework.beans.factory.FactoryBean.getObjectType. Doc from org.springframework.beans.factory.FactoryBean.getObjectType. Return the type of object that this FactoryBean creates, or `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. Returns:Class<?> the type of object that this FactoryBean creates, or `null` if not known at the time of the call Annotations @Override

public Class<?> getObjectType()

Implements org.springframework.beans.factory.FactoryBean.getObjectType.

Doc from org.springframework.beans.factory.FactoryBean.getObjectType.

Return the type of object that this FactoryBean creates, or 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.

Returns:Class<?>

the type of object that this FactoryBean creates, or null if not known at the time of the call

Annotations

@Override

isSingleton back to summary

isSingleton	back to summary
public boolean isSingleton() Overrides default org.springframework.beans.factory.FactoryBean.isSingleton. Doc from org.springframework.beans.factory.FactoryBean.isSingleton. Is the object managed by this factory a singleton? That is, will `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. Returns:boolean whether the exposed object is a singleton Annotations @Override

public boolean isSingleton()

Overrides default org.springframework.beans.factory.FactoryBean.isSingleton.

Doc from org.springframework.beans.factory.FactoryBean.isSingleton.

Is the object managed by this factory a singleton? That is, will 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.

Returns:boolean

whether the exposed object is a singleton

Annotations

@Override

setBeanName back to summary

setBeanName	back to summary
public void setBeanName(String beanName) Implements org.springframework.beans.factory.BeanNameAware.setBeanName. Doc from org.springframework.beans.factory.BeanNameAware.setBeanName. Set the name of the bean in the bean factory that created this bean. Invoked after population of normal bean properties but before an init callback such as `InitializingBean#afterPropertiesSet()` or a custom init-method. Parameters beanName:String 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. Annotations @Override

public void setBeanName(String beanName)

Implements org.springframework.beans.factory.BeanNameAware.setBeanName.

Doc from org.springframework.beans.factory.BeanNameAware.setBeanName.

Set the name of the bean in the bean factory that created this bean.

Invoked after population of normal bean properties but before an init callback such as InitializingBean#afterPropertiesSet() or a custom init-method.

Parameters

beanName:String: 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.

Annotations

@Override

setCalendarName	back to summary
public void setCalendarName(String calendarName) Associate a specific calendar with this cron trigger.

setCronExpression	back to summary
public void setCronExpression(String cronExpression) Specify the cron expression for this trigger.

setDescription	back to summary
public void setDescription(String description) Associate a textual description with this trigger.

setGroup	back to summary
public void setGroup(String group) Specify the trigger's group.

setJobDataAsMap	back to summary
public void setJobDataAsMap(Map<String, ?> jobDataAsMap) Register objects in the JobDataMap via a given Map. These objects will be available to this Trigger only, in contrast to objects in the JobDetail's data map. Parameters jobDataAsMap:Map<String, ?> a Map with String keys and any objects as values (for example Spring-managed beans)

setJobDataAsMap

back to summary

public void setJobDataAsMap(Map<String, ?> jobDataAsMap)

These objects will be available to this Trigger only, in contrast to objects in the JobDetail's data map.

Parameters

jobDataAsMap:Map<String, ?>: a Map with String keys and any objects as values (for example Spring-managed beans)

setJobDataMap back to summary

setJobDataMap	back to summary
public void setJobDataMap(org.quartz.JobDataMap jobDataMap) Set the trigger's JobDataMap. See Also `setJobDataAsMap`

public void setJobDataMap(org.quartz.JobDataMap jobDataMap)

Set the trigger's JobDataMap.

See Also: setJobDataAsMap

setJobDetail	back to summary
public void setJobDetail(org.quartz.JobDetail jobDetail) Set the JobDetail that this trigger should be associated with.

setMisfireInstruction	back to summary
public void setMisfireInstruction(int misfireInstruction) Specify the misfire instruction for this trigger.

setMisfireInstructionName back to summary

setMisfireInstructionName	back to summary
public void setMisfireInstructionName(String constantName) Set the misfire instruction for this trigger via the name of the corresponding constant in the `org.quartz.Trigger` and `org.quartz.CronTrigger` classes. Default is `MISFIRE_INSTRUCTION_SMART_POLICY`. See Also `org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY`, `org.quartz.Trigger#MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY`, `org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW`, `org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING`

public void setMisfireInstructionName(String constantName)

Set the misfire instruction for this trigger via the name of the corresponding constant in the org.quartz.Trigger and org.quartz.CronTrigger classes.

Default is MISFIRE_INSTRUCTION_SMART_POLICY.

See Also: org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY, org.quartz.Trigger#MISFIRE_INSTRUCTION_IGNORE_MISFIRE_POLICY, org.quartz.CronTrigger#MISFIRE_INSTRUCTION_FIRE_ONCE_NOW, org.quartz.CronTrigger#MISFIRE_INSTRUCTION_DO_NOTHING

setName	back to summary
public void setName(String name) Specify the trigger's name.

setPriority	back to summary
public void setPriority(int priority) Specify the priority of this trigger.

setStartDelay	back to summary
public void setStartDelay(long startDelay) Set the start delay in milliseconds. The start delay is added to the current system time (when the bean starts) to control the start time of the trigger.

setStartDelay

back to summary

public void setStartDelay(long startDelay)

Set the start delay in milliseconds.

The start delay is added to the current system time (when the bean starts) to control the start time of the trigger.

setStartTime back to summary

setStartTime	back to summary
public void setStartTime(Date startTime) Set a specific start time for the trigger. Note that a dynamically computed `setStartDelay` specification overrides a static timestamp set here.

public void setStartTime(Date startTime)

Set a specific start time for the trigger.

Note that a dynamically computed setStartDelay specification overrides a static timestamp set here.

setTimeZone	back to summary
public void setTimeZone(TimeZone timeZone) Specify the time zone for this trigger's cron expression.

public Class CronTriggerFactoryBean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail