public class

MethodInvokingJobDetailFactoryBean

extends ArgumentConvertingMethodInvoker
implements BeanClassLoaderAware BeanFactoryAware BeanNameAware FactoryBean<T> InitializingBean
java.lang.Object
   ↳ org.springframework.util.MethodInvoker
     ↳ org.springframework.beans.support.ArgumentConvertingMethodInvoker
       ↳ org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

Class Overview

FactoryBean that exposes a org.quartz.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.

See Also

Summary

Nested Classes
class MethodInvokingJobDetailFactoryBean.MethodInvokingJob Quartz Job implementation that invokes a specified method. 
class MethodInvokingJobDetailFactoryBean.StatefulMethodInvokingJob Extension of the MethodInvokingJob, implementing the StatefulJob interface. 
Public Constructors
MethodInvokingJobDetailFactoryBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Object getObject()
Return an instance (possibly shared or independent) of the object managed by this factory.
Class<?> 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 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.

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 setJobListenerNames(String[] names)
Set a list of JobListener names for this job, referring to non-global JobListeners registered with the Scheduler.
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.
Protected Methods
void postProcessJobDetail(JobDetail jobDetail)
Callback for post-processing the JobDetail to be exposed by this FactoryBean.
Class resolveClassName(String className)
Resolve the given class name into a Class.
[Expand]
Inherited Methods
From class org.springframework.beans.support.ArgumentConvertingMethodInvoker
From class org.springframework.util.MethodInvoker
From class java.lang.Object
From interface org.springframework.beans.factory.BeanClassLoaderAware
From interface org.springframework.beans.factory.BeanFactoryAware
From interface org.springframework.beans.factory.BeanNameAware
From interface org.springframework.beans.factory.FactoryBean
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public MethodInvokingJobDetailFactoryBean ()

Public Methods

public void afterPropertiesSet ()

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

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.

Throws
ClassNotFoundException
NoSuchMethodException

public Object 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
  • an instance of the bean (can be null)

public Class<?> 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
  • the type of object that this FactoryBean creates, or null if not known at the time of the call

public Class getTargetClass ()

Overridden to support the "targetBeanName" feature.

public Object getTargetObject ()

Overridden to support the "targetBeanName" feature.

public boolean 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 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.

Returns
  • whether the exposed object is a singleton

public void setBeanClassLoader (ClassLoader classLoader)

Callback that supplies the bean class loader to a bean instance.

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

Parameters
classLoader the owning class loader; may be null in which case a default ClassLoader must be used, for example the ClassLoader obtained via getDefaultClassLoader()

public void setBeanFactory (BeanFactory beanFactory)

Callback that supplies the owning factory to a bean instance.

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

Parameters
beanFactory owning BeanFactory (never null). The bean can immediately call methods on the factory.

public void setBeanName (String beanName)

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 afterPropertiesSet() or a custom init-method.

Parameters
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 setConcurrent (boolean concurrent)

Specify whether or not multiple jobs should be run in a concurrent fashion. The behavior when one does not want concurrent jobs to be executed is realized through adding the StatefulJob interface. More information on stateful versus stateless jobs can be found here.

The default setting is to run jobs concurrently.

public void setGroup (String group)

Set the group of the job.

Default is the default group of the Scheduler.

See Also
  • org.quartz.JobDetail#setGroup
  • org.quartz.Scheduler#DEFAULT_GROUP

public void setJobListenerNames (String[] names)

Set a list of JobListener names for this job, referring to non-global JobListeners registered with the Scheduler.

A JobListener name always refers to the name returned by the JobListener implementation.

See Also

public void setName (String name)

Set the name of the job.

Default is the bean name of this FactoryBean.

See Also
  • org.quartz.JobDetail#setName

public void setTargetBeanName (String targetBeanName)

Set the name of the target bean in the Spring BeanFactory.

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).

Protected Methods

protected void postProcessJobDetail (JobDetail jobDetail)

Callback for post-processing the JobDetail to be exposed by this FactoryBean.

The default implementation is empty. Can be overridden in subclasses.

Parameters
jobDetail the JobDetail prepared by this FactoryBean

protected Class resolveClassName (String className)

Resolve the given class name into a Class.

The default implementations uses ClassUtils.forName, using the thread context class loader.

Parameters
className the class name to resolve
Returns
  • the resolved Class
Throws
ClassNotFoundException