org.springframework.scheduling.timer
Class TimerFactoryBean

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

public class TimerFactoryBean
extends java.lang.Object
implements FactoryBean, InitializingBean, DisposableBean

FactoryBean that sets up a J2SE Timer and exposes it for bean references.

Allows registration of ScheduledTimerTasks, automatically starting the timer on initialization and cancelling it on destruction. In typical scenarios, 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  org.apache.commons.logging.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  java.util.Timer createTimer(boolean daemon)
          Create a new Timer instance.
 void destroy()
          This implementation cancels the Timer, stopping all scheduled tasks.
 java.lang.Object getObject()
          Return an instance (possibly shared or independent) of the object managed by this factory.
 java.lang.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? That is, will getObject() always return the same object?
 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 org.apache.commons.logging.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.

See Also:
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 java.util.Timer createTimer(boolean daemon)
Create a new Timer instance. Called by afterPropertiesSet. Can be overridden in subclasses to provide custom Timer subclasses.

Returns:
a new Timer instance
See Also:
afterPropertiesSet(), Timer.Timer(boolean)

getObject

public java.lang.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.

Specified by:
getObject in interface FactoryBean
Returns:
an instance of the bean (should never be null)

getObjectType

public java.lang.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, e.g. on autowiring.

For a singleton, this can simply return getObject().getClass(), or even null, as autowiring will always check the actual objects for singletons. For prototypes, returning a meaningful type here is highly advisable, as autowiring will simply ignore them else.

Specified by:
getObjectType in interface FactoryBean
Returns:
the type of object that this FactoryBean creates, or null
See Also:
ListableBeanFactory.getBeansOfType(java.lang.Class, boolean, boolean)

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?

The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory.

Specified by:
isSingleton in interface FactoryBean
Returns:
if this bean is a singleton

destroy

public void destroy()
This implementation cancels the Timer, stopping all scheduled tasks.

Specified by:
destroy in interface DisposableBean


Copyright (C) 2003-2004 The Spring Framework Project.