org.springframework.scheduling.quartz
Class MethodInvokingJobDetailFactoryBean

java.lang.Object
  org.springframework.util.MethodInvoker
      org.springframework.beans.support.ArgumentConvertingMethodInvoker
          org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

All Implemented Interfaces:

BeanNameAware, FactoryBean, InitializingBean

public class MethodInvokingJobDetailFactoryBean
extends ArgumentConvertingMethodInvoker
implements FactoryBean, BeanNameAware, InitializingBean

FactoryBean that exposes a JobDetail object that delegates job execution to a specified (static or non-static) method. Avoids the need to implement a one-line Quartz Job that just invokes an existing service method.

Derived from MethodInvoker to share common properties and behavior with MethodInvokingFactoryBean.

Supports both concurrently running jobs and non-currently running ones through the "concurrent" property.

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.

Since:

18.02.2004

Author:

Juergen Hoeller, Alef Arendsen

See Also:

MethodInvoker.setTargetObject(java.lang.Object), MethodInvoker.setTargetMethod(java.lang.String), setConcurrent(boolean), MethodInvokingFactoryBean

Nested Class Summary

static class	MethodInvokingJobDetailFactoryBean.MethodInvokingJob Quartz Job implementation that invokes a specified method.
static class	MethodInvokingJobDetailFactoryBean.StatefulMethodInvokingJob Extension of the MethodInvokingJob, implementing the StatefulJob interface.

Nested classes/interfaces inherited from class org.springframework.util.MethodInvoker

MethodInvoker.VoidType

Field Summary

Fields inherited from class org.springframework.util.MethodInvoker

VOID

Constructor Summary

MethodInvokingJobDetailFactoryBean()

Method Summary

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.
boolean	isSingleton() Is the bean managed by this factory a singleton or a prototype?
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.

Methods inherited from class org.springframework.beans.support.ArgumentConvertingMethodInvoker

findMatchingMethod, registerCustomEditor

Methods inherited from class org.springframework.util.MethodInvoker

getArguments, getPreparedMethod, getTargetClass, getTargetMethod, getTargetObject, invoke, prepare, setArguments, setStaticMethod, setTargetClass, setTargetMethod, setTargetObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MethodInvokingJobDetailFactoryBean

public MethodInvokingJobDetailFactoryBean()

Method Detail

setName

public void setName(String name)

Set the name of the job. Default is the bean name of this FactoryBean.

See Also:

JobDetail.setName(java.lang.String)

setGroup

public void setGroup(String group)

Set the group of the job. Default is the default group of the Scheduler.

See Also:

JobDetail.setGroup(java.lang.String), Scheduler.DEFAULT_GROUP

setConcurrent

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.

Parameters:

concurrent - whether one wants to execute multiple jobs created by this bean concurrently

setBeanName

public void setBeanName(String beanName)

Description copied from interface: BeanNameAware

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 like InitializingBean's afterPropertiesSet or a custom init-method.

Specified by:

setBeanName in interface BeanNameAware

Parameters:

beanName - the name of the bean in the factory

afterPropertiesSet

public void afterPropertiesSet()
                        throws ClassNotFoundException,
                               NoSuchMethodException

Description copied from interface: InitializingBean

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.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

ClassNotFoundException

NoSuchMethodException

getObject

public Object getObject()

Description copied from interface: FactoryBean

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 method returns null, the factory will consider the FactoryBean as not fully initialized and throw a corresponding FactoryBeanNotInitializedException.

Specified by:

getObject in interface FactoryBean

Returns:

an instance of the bean (should not be null; a null value will be considered as an indication of incomplete initialization)

See Also:

FactoryBeanNotInitializedException

getObjectType

public Class getObjectType()

Description copied from interface: FactoryBean

Return the type of object that this FactoryBean creates, or null if not known in advance. This allows to check for specific types of beans without instantiating objects, for example on autowiring.

For a singleton, this 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.

Specified by:

getObjectType in interface FactoryBean

Returns:

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

See Also:

ListableBeanFactory.getBeansOfType(java.lang.Class)

isSingleton

public boolean isSingleton()

Description copied from interface: FactoryBean

Is the bean managed by this factory a singleton or a prototype? 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.

Specified by:

isSingleton in interface FactoryBean

Returns:

if this bean is a singleton

See Also:

FactoryBean.getObject()