org.springframework.scheduling.timer
Class TimerFactoryBean

java.lang.Object
  extended by org.springframework.scheduling.timer.TimerFactoryBean
All Implemented Interfaces:
DisposableBean, FactoryBean, InitializingBean

public class TimerFactoryBean
extends Object
implements FactoryBean, InitializingBean, DisposableBean

FactoryBean that sets up a JDK 1.3+ Timer and exposes it for bean references.

Allows for registration of ScheduledTimerTasks, automatically starting the Timer on initialization and cancelling it on destruction of the context. In scenarios that just require static registration of tasks at startup, there is no need to access the Timer instance itself in application code.

Note that Timer uses a TimerTask instance that is shared between repeated executions, in contrast to Quartz which instantiates a new Job for each execution.

Since:
19.02.2004
Author:
Juergen Hoeller
See Also:
ScheduledTimerTask, Timer, TimerTask

Field Summary
protected  Log logger
           
 
Constructor Summary
TimerFactoryBean()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
protected  Timer createTimer(boolean daemon)
          Create a new Timer instance.
 void destroy()
          Cancel the Timer on bean factory shutdown, stopping all scheduled tasks.
 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 setDaemon(boolean daemon)
          Set whether the timer should use a daemon thread, just executing as long as the application itself is running.
 void setScheduledTimerTasks(ScheduledTimerTask[] scheduledTimerTasks)
          Register a list of ScheduledTimerTask objects with the Timer that this FactoryBean creates.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logger

protected final Log logger
Constructor Detail

TimerFactoryBean

public TimerFactoryBean()
Method Detail

setScheduledTimerTasks

public void setScheduledTimerTasks(ScheduledTimerTask[] scheduledTimerTasks)
Register a list of ScheduledTimerTask objects with the Timer that this FactoryBean creates. Depending on each SchedulerTimerTask's settings, it will be registered via one of Timer's schedule methods.

See Also:
Timer.schedule(java.util.TimerTask, long), Timer.schedule(java.util.TimerTask, long, long), Timer.scheduleAtFixedRate(java.util.TimerTask, long, long)

setDaemon

public void setDaemon(boolean daemon)
Set whether the timer should use a daemon thread, just executing as long as the application itself is running.

Default is "true": In a J2EE environment, the container is in control of the application lifecycle.

See Also:
Timer.Timer(boolean)

afterPropertiesSet

public void afterPropertiesSet()
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

createTimer

protected Timer createTimer(boolean daemon)
Create a new Timer instance. Called by afterPropertiesSet. Can be overridden in subclasses to provide custom Timer subclasses.

Parameters:
daemon - whether to create a Timer that runs as daemon thread
Returns:
a new Timer instance
See Also:
afterPropertiesSet(), Timer.Timer(boolean)

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

destroy

public void destroy()
Cancel the Timer on bean factory shutdown, stopping all scheduled tasks.

Specified by:
destroy in interface DisposableBean
See Also:
Timer.cancel()


Copyright (c) 2002-2007 The Spring Framework Project.