|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.scheduling.timer.TimerFactoryBean
public class TimerFactoryBean
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.
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 |
---|
protected final Log logger
Constructor Detail |
---|
public TimerFactoryBean()
Method Detail |
---|
public void setScheduledTimerTasks(ScheduledTimerTask[] scheduledTimerTasks)
Timer.schedule(java.util.TimerTask, long)
,
Timer.schedule(java.util.TimerTask, long, long)
,
Timer.scheduleAtFixedRate(java.util.TimerTask, long, long)
public void setDaemon(boolean daemon)
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.
Timer.Timer(boolean)
public void afterPropertiesSet()
InitializingBean
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.
afterPropertiesSet
in interface InitializingBean
protected Timer createTimer(boolean daemon)
afterPropertiesSet
.
Can be overridden in subclasses to provide custom Timer subclasses.
daemon
- whether to create a Timer that runs as daemon thread
afterPropertiesSet()
,
Timer.Timer(boolean)
public Object getObject()
FactoryBean
As with a BeanFactory
, this allows support for both the
Singleton and Prototype design pattern.
If this FactoryBean is not fully initialized yet at the time of
the call (for example because it is involved in a circular reference),
throw a corresponding FactoryBeanNotInitializedException
.
As of Spring 2.0, FactoryBeans are allowed to return null
objects. The factory will consider this as normal value to be used; it
will not throw a FactoryBeanNotInitializedException in this case anymore.
FactoryBean implementations are encouraged to throw
FactoryBeanNotInitializedException themselves now, as appropriate.
getObject
in interface FactoryBean
null
)FactoryBeanNotInitializedException
public Class getObjectType()
FactoryBean
null
if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method 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.
getObjectType
in interface FactoryBean
null
if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class)
public boolean isSingleton()
FactoryBean
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.
isSingleton
in interface FactoryBean
FactoryBean.getObject()
public void destroy()
destroy
in interface DisposableBean
Timer.cancel()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |