public class JobDetailFactoryBean extends java.lang.Object implements FactoryBean<org.quartz.JobDetail>, BeanNameAware, ApplicationContextAware, InitializingBean
FactoryBeanfor creating a Quartz
JobDetailinstance, supporting bean-style usage for JobDetail configuration.
JobDetail(Impl) itself is already a JavaBean but lacks
sensible defaults. This class uses the Spring bean name as job name,
and the Quartz default group ("DEFAULT") as job group if not specified.
NOTE: This FactoryBean works against both Quartz 1.x and Quartz 2.0/2.1,
in contrast to the older
|Constructor and Description|
|Modifier and Type||Method and Description|
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Return the job's JobDataMap.
Return an instance (possibly shared or independent) of the object managed by this factory.
Return the type of object that this FactoryBean creates, or
Is the object managed by this factory a singleton? That is, will
Set the ApplicationContext that this object runs in.
Set the key of an ApplicationContext reference to expose in the JobDataMap, for example "applicationContext".
Set the name of the bean in the bean factory that created this bean.
Set a textual description for this job.
Specify the job's durability, i.e.
Specify the job's group.
Specify the job's implementation class.
Register objects in the JobDataMap via a given Map.
Set the job's JobDataMap.
Specify the job's name.
public void setName(java.lang.String name)
public void setGroup(java.lang.String group)
public void setJobClass(java.lang.Class jobClass)
public void setJobDataMap(org.quartz.JobDataMap jobDataMap)
public org.quartz.JobDataMap getJobDataMap()
public void setJobDataAsMap(java.util.Map<java.lang.String,?> jobDataAsMap)
These objects will be available to this Job only, in contrast to objects in the SchedulerContext.
Note: When using persistent Jobs whose JobDetail will be kept in the database, do not put Spring-managed beans or an ApplicationContext reference into the JobDataMap but rather into the SchedulerContext.
jobDataAsMap- Map with String keys and any objects as values (for example Spring-managed beans)
public void setDurability(boolean durability)
public void setDescription(java.lang.String description)
public void setBeanName(java.lang.String beanName)
Invoked after population of normal bean properties but before an
init callback such as
or a custom init-method.
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 setApplicationContext(ApplicationContext applicationContext)
Invoked after population of normal bean properties but before an init callback such
or a custom init-method. Invoked after
MessageSourceAware, if applicable.
public void setApplicationContextJobDataKey(java.lang.String applicationContextJobDataKey)
In case of a QuartzJobBean, the reference will be applied to the Job instance as bean property. An "applicationContext" attribute will correspond to a "setApplicationContext" method in that scenario.
Note that BeanFactory callback interfaces like ApplicationContextAware are not automatically applied to Quartz Job instances, because Quartz itself is responsible for the lifecycle of its Jobs.
Note: When using persistent job stores where JobDetail contents will be kept in the database, do not put an ApplicationContext reference into the JobDataMap but rather into the SchedulerContext.
public void afterPropertiesSet()
This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.
public org.quartz.JobDetail getObject()
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
As of Spring 2.0, FactoryBeans are allowed to return
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.
public java.lang.Class<?> getObjectType()
nullif 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.
nullif not known at the time of the call
public boolean isSingleton()
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
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
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype() method. Plain
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton() implementation returns