org.springframework.scheduling.timer
Class MethodInvokingTimerTaskFactoryBean

java.lang.Object
  org.springframework.util.MethodInvoker
      org.springframework.beans.support.ArgumentConvertingMethodInvoker
          org.springframework.scheduling.support.MethodInvokingRunnable
              org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean

All Implemented Interfaces:

Runnable, FactoryBean, InitializingBean

public class MethodInvokingTimerTaskFactoryBean
extends MethodInvokingRunnable
implements FactoryBean

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

Derives from MethodInvokingRunnable to share common properties and behavior, effectively providing a TimerTask adapter for it.

Often used to populate a ScheduledTimerTask object with a specific reflective method invocation. Note that you can alternatively populate a ScheduledTimerTask object with a plain MethodInvokingRunnable instance as well (as of Spring 1.2.4), without the need for this special FactoryBean.

Since:

19.02.2004

Author:

Juergen Hoeller

See Also:

DelegatingTimerTask, ScheduledTimerTask.setTimerTask(java.util.TimerTask), ScheduledTimerTask.setRunnable(java.lang.Runnable), MethodInvokingRunnable, MethodInvokingFactoryBean

Nested Class Summary

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

MethodInvoker.VoidType

Field Summary

Fields inherited from class org.springframework.scheduling.support.MethodInvokingRunnable

logger

Fields inherited from class org.springframework.util.MethodInvoker

VOID

Constructor Summary

MethodInvokingTimerTaskFactoryBean()

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?

Methods inherited from class org.springframework.scheduling.support.MethodInvokingRunnable

getInvocationFailureMessage, run

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

MethodInvokingTimerTaskFactoryBean

public MethodInvokingTimerTaskFactoryBean()

Method Detail

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

Overrides:

afterPropertiesSet in class MethodInvokingRunnable

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