public class MethodInvokingJobDetailFactoryBean extends ArgumentConvertingMethodInvoker implements FactoryBean<JobDetail>, BeanNameAware, BeanClassLoaderAware, BeanFactoryAware, InitializingBean
FactoryBeanthat exposes a
JobDetailobject which delegates job execution to a specified (static or non-static) method. Avoids the need for implementing a one-line Quartz Job that just invokes an existing service method on a Spring-managed target bean.
Inherits common configuration properties from the
base class, such as
"targetMethod", adding support for lookup of the target
bean by name through the
(as alternative to specifying a "targetObject" directly, allowing for
non-singleton target objects).
Supports both concurrently running jobs and non-currently running jobs through the "concurrent" property. Jobs created by this MethodInvokingJobDetailFactoryBean are by default volatile and durable (according to Quartz terminology).
NOTE: JobDetails created via this FactoryBean are not serializable and thus not suitable for persistent job stores. You need to implement your own Quartz Job as a thin wrapper for each case where you want a persistent job to delegate to a specific service method.
Compatible with Quartz 2.1.4 and higher, as of Spring 4.1.
|Modifier and Type||Class and Description|
Quartz Job implementation that invokes a specified method.
Extension of the MethodInvokingJob, implementing the StatefulJob interface.
|Constructor and Description|
|Modifier and Type||Method and Description|
Invoked by the containing
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
Callback for post-processing the JobDetail to be exposed by this FactoryBean.
Resolve the given class name into a Class.
Callback that supplies the bean
Callback that supplies the owning factory to a bean instance.
Set the name of the bean in the bean factory that created this bean.
Specify whether or not multiple jobs should be run in a concurrent fashion.
Set the group of the job.
Set the name of the job.
Set the name of the target bean in the Spring BeanFactory.
doFindMatchingMethod, findMatchingMethod, getDefaultTypeConverter, getTypeConverter, registerCustomEditor, setTypeConverter
getArguments, getPreparedMethod, getTargetMethod, getTypeDifferenceWeight, invoke, isPrepared, prepare, setArguments, setStaticMethod, setTargetClass, setTargetMethod, setTargetObject
public void setName(String name)
Default is the bean name of this FactoryBean.
public void setGroup(String group)
Default is the default group of the Scheduler.
public void setConcurrent(boolean concurrent)
@DisallowConcurrentExecutionmarkers. More information on stateful versus stateless jobs can be found here.
The default setting is to run jobs concurrently.
public void setTargetBeanName(String targetBeanName)
This is an alternative to specifying
allowing for non-singleton beans to be invoked. Note that specified
"targetClass" values will
override the corresponding effect of this "targetBeanName" setting
(i.e. statically pre-define the bean type or even the bean object).
public void setBeanName(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 setBeanClassLoader(ClassLoader classLoader)
class loaderto a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
method or a custom init-method.
classLoader- the owning class loader
public void setBeanFactory(BeanFactory beanFactory)
Invoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
beanFactory- owning BeanFactory (never
null). The bean can immediately call methods on the factory.
protected Class<?> resolveClassName(String className) throws ClassNotFoundException
The default implementations uses
using the thread context class loader.
className- the class name to resolve
ClassNotFoundException- if the class name was invalid
public void afterPropertiesSet() throws ClassNotFoundException, NoSuchMethodException
BeanFactoryafter it has set all bean properties and satisfied
This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected void postProcessJobDetail(JobDetail jobDetail)
The default implementation is empty. Can be overridden in subclasses.
jobDetail- the JobDetail prepared by this FactoryBean
public Class<?> getTargetClass()
public Object getTargetObject()
@Nullable public 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 Class<? extends JobDetail> 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
The default implementation returns
true, since a
FactoryBean typically manages a singleton instance.