public class MethodInvokingJobDetailFactoryBean extends ArgumentConvertingMethodInvoker implements FactoryBean<JobDetail>, BeanNameAware, BeanClassLoaderAware, BeanFactoryAware, InitializingBean
FactoryBean that exposes a
JobDetail object 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 MethodInvoker
base class, such as "targetObject" and
"targetMethod", adding support for lookup of the target
bean by name through the "targetBeanName" property
(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.
setTargetBeanName(java.lang.String),
MethodInvoker.setTargetObject(java.lang.Object),
MethodInvoker.setTargetMethod(java.lang.String),
setConcurrent(boolean)| Modifier and Type | Class and Description |
|---|---|
static class |
MethodInvokingJobDetailFactoryBean.MethodInvokingJob
Quartz Job implementation that invokes a specified method.
|
static class |
MethodInvokingJobDetailFactoryBean.StatefulMethodInvokingJob
Extension of the MethodInvokingJob, implementing the StatefulJob interface.
|
targetClassOBJECT_TYPE_ATTRIBUTE| Constructor and Description |
|---|
MethodInvokingJobDetailFactoryBean() |
| 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. |
JobDetail |
getObject()
Return an instance (possibly shared or independent) of the object
managed by this factory.
|
Class<? extends JobDetail> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
Class<?> |
getTargetClass()
Overridden to support the
"targetBeanName" feature. |
Object |
getTargetObject()
Overridden to support the
"targetBeanName" feature. |
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)? |
protected void |
postProcessJobDetail(JobDetail jobDetail)
Callback for post-processing the JobDetail to be exposed by this FactoryBean.
|
protected Class<?> |
resolveClassName(String className)
Resolve the given class name into a Class.
|
void |
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the bean
class loader to
a bean instance. |
void |
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.
|
void |
setBeanName(String beanName)
Set the name of the bean in the bean factory that created this bean.
|
void |
setConcurrent(boolean concurrent)
Specify whether or not multiple jobs should be run in a concurrent fashion.
|
void |
setGroup(String group)
Set the group of the job.
|
void |
setName(String name)
Set the name of the job.
|
void |
setTargetBeanName(String targetBeanName)
Set the name of the target bean in the Spring BeanFactory.
|
doFindMatchingMethod, findMatchingMethod, getDefaultTypeConverter, getTypeConverter, registerCustomEditor, setTypeConvertergetArguments, getPreparedMethod, getTargetMethod, getTypeDifferenceWeight, invoke, isPrepared, prepare, setArguments, setStaticMethod, setTargetClass, setTargetMethod, setTargetObjectpublic 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.
Scheduler.DEFAULT_GROUPpublic void setConcurrent(boolean concurrent)
@PersistJobDataAfterExecution and
@DisallowConcurrentExecution markers.
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 "targetObject",
allowing for non-singleton beans to be invoked. Note that specified
"targetObject" and "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)
BeanNameAwareInvoked after population of normal bean properties but before an
init callback such as InitializingBean.afterPropertiesSet()
or a custom init-method.
setBeanName in interface BeanNameAwarebeanName - 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)
BeanClassLoaderAwareclass loader to
a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
InitializingBean's
InitializingBean.afterPropertiesSet()
method or a custom init-method.
setBeanClassLoader in interface BeanClassLoaderAwareclassLoader - the owning class loaderpublic void setBeanFactory(BeanFactory beanFactory)
BeanFactoryAwareInvoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
setBeanFactory in interface BeanFactoryAwarebeanFactory - owning BeanFactory (never null).
The bean can immediately call methods on the factory.BeanInitializationExceptionprotected Class<?> resolveClassName(String className) throws ClassNotFoundException
MethodInvokerThe default implementations uses ClassUtils.forName,
using the thread context class loader.
resolveClassName in class MethodInvokerclassName - the class name to resolveClassNotFoundException - if the class name was invalidpublic void afterPropertiesSet()
throws ClassNotFoundException,
NoSuchMethodException
InitializingBeanBeanFactory 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 InitializingBeanClassNotFoundExceptionNoSuchMethodExceptionprotected void postProcessJobDetail(JobDetail jobDetail)
The default implementation is empty. Can be overridden in subclasses.
jobDetail - the JobDetail prepared by this FactoryBeanpublic Class<?> getTargetClass()
"targetBeanName" feature.getTargetClass in class MethodInvokerpublic Object getTargetObject()
"targetBeanName" feature.getTargetObject in class MethodInvoker@Nullable public JobDetail getObject()
FactoryBeanAs 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<JobDetail>null)FactoryBeanNotInitializedExceptionpublic Class<? extends JobDetail> getObjectType()
FactoryBeannull 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<JobDetail>null if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)public boolean isSingleton()
FactoryBeanFactoryBean.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<JobDetail>FactoryBean.getObject(),
SmartFactoryBean.isPrototype()