spring-context

org.springframework.scheduling.timer
Class TimerFactoryBean

java.lang.Object
  extended by org.springframework.scheduling.timer.TimerFactoryBean
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.Timer>, org.springframework.beans.factory.InitializingBean

Deprecated. as of Spring 3.0, in favor of the scheduling.concurrent package which is based on Java 5's java.util.concurrent.ExecutorService

@Deprecated
public class TimerFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<java.util.Timer>, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean

FactoryBean that sets up a 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 at all.

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

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

Field Summary
protected  org.apache.commons.logging.Log logger
          Deprecated.  
 
Constructor Summary
TimerFactoryBean()
          Deprecated.  
 
Method Summary
 void afterPropertiesSet()
          Deprecated.  
protected  java.util.Timer createTimer(java.lang.String name, boolean daemon)
          Deprecated. Create a new Timer instance.
 void destroy()
          Deprecated. Cancel the Timer on bean factory shutdown, stopping all scheduled tasks.
 java.util.Timer getObject()
          Deprecated.  
 java.lang.Class<? extends java.util.Timer> getObjectType()
          Deprecated.  
 boolean isSingleton()
          Deprecated.  
protected  void registerTasks(ScheduledTimerTask[] tasks, java.util.Timer timer)
          Deprecated. Register the specified ScheduledTimerTasks on the given Timer.
 void setBeanName(java.lang.String beanName)
          Deprecated.  
 void setDaemon(boolean daemon)
          Deprecated. Set whether the timer should use a daemon thread, just executing as long as the application itself is running.
 void setScheduledTimerTasks(ScheduledTimerTask[] scheduledTimerTasks)
          Deprecated. 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
Deprecated. 
Constructor Detail

TimerFactoryBean

public TimerFactoryBean()
Deprecated. 
Method Detail

setScheduledTimerTasks

public void setScheduledTimerTasks(ScheduledTimerTask[] scheduledTimerTasks)
Deprecated. 
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)
Deprecated. 
Set whether the timer should use a daemon thread, just executing as long as the application itself is running.

Default is "false": The timer will automatically get cancelled on destruction of this FactoryBean. Hence, if the application shuts down, tasks will by default finish their execution. Specify "true" for eager shutdown of threads that execute tasks.

See Also:
Timer.Timer(boolean)

setBeanName

public void setBeanName(java.lang.String beanName)
Deprecated. 
Specified by:
setBeanName in interface org.springframework.beans.factory.BeanNameAware

afterPropertiesSet

public void afterPropertiesSet()
Deprecated. 
Specified by:
afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

createTimer

protected java.util.Timer createTimer(java.lang.String name,
                                      boolean daemon)
Deprecated. 
Create a new Timer instance. Called by afterPropertiesSet. Can be overridden in subclasses to provide custom Timer subclasses.

Parameters:
name - the desired name of the Timer's associated thread
daemon - whether to create a Timer that runs as daemon thread
Returns:
a new Timer instance
See Also:
afterPropertiesSet(), Timer.Timer(boolean)

registerTasks

protected void registerTasks(ScheduledTimerTask[] tasks,
                             java.util.Timer timer)
Deprecated. 
Register the specified ScheduledTimerTasks on the given Timer.

Parameters:
tasks - the specified ScheduledTimerTasks (never empty)
timer - the Timer to register the tasks on.

getObject

public java.util.Timer getObject()
Deprecated. 
Specified by:
getObject in interface org.springframework.beans.factory.FactoryBean<java.util.Timer>

getObjectType

public java.lang.Class<? extends java.util.Timer> getObjectType()
Deprecated. 
Specified by:
getObjectType in interface org.springframework.beans.factory.FactoryBean<java.util.Timer>

isSingleton

public boolean isSingleton()
Deprecated. 
Specified by:
isSingleton in interface org.springframework.beans.factory.FactoryBean<java.util.Timer>

destroy

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

Specified by:
destroy in interface org.springframework.beans.factory.DisposableBean
See Also:
Timer.cancel()

spring-context