TimerManagerFactoryBean (Spring Framework API 2.1) - Spring Framework 2.1.0 API 文档英文版

org.springframework.scheduling.commonj
Class TimerManagerFactoryBean

java.lang.Object
  org.springframework.jndi.JndiAccessor
      org.springframework.jndi.JndiLocatorSupport
          org.springframework.scheduling.commonj.TimerManagerFactoryBean

All Implemented Interfaces:

DisposableBean, FactoryBean, InitializingBean, Lifecycle

public class TimerManagerFactoryBean
extends JndiLocatorSupport
implements FactoryBean, InitializingBean, DisposableBean, Lifecycle

FactoryBean that retrieves a CommonJ TimerManager and exposes it for bean references.

This is the central convenience class for setting up a CommonJ TimerManager in a Spring context.

Allows for registration of ScheduledTimerListeners. This is the main purpose of this class; the TimerManager itself could also be fetched from JNDI via JndiObjectFactoryBean. In scenarios that just require static registration of tasks at startup, there is no need to access the TimerManager itself in application code.

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

Since:

2.0

Author:

Juergen Hoeller

See Also:

ScheduledTimerListener, TimerManager, TimerListener

Field Summary

 

Fields inherited from class org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX

 

Fields inherited from class org.springframework.jndi.JndiAccessor
logger

 

Constructor Summary
TimerManagerFactoryBean()

 

Method Summary
void	afterPropertiesSet()           Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
void	destroy()           Cancels all statically registered Timers on shutdown, and stops the underlying TimerManager (if not shared).
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	isRunning()           Considers the underlying TimerManager as running if it is neither suspending nor stopping.
boolean	isSingleton()           Is the object managed by this factory a singleton?
void	setScheduledTimerListeners(ScheduledTimerListener[] scheduledTimerListeners)           Register a list of ScheduledTimerListener objects with the TimerManager that this FactoryBean creates.
void	setShared(boolean shared)           Specify whether the TimerManager obtained by this FactoryBean is a shared instance ("true") or an independent instance ("false").
void	setTimerManager(commonj.timers.TimerManager timerManager)           Specify the CommonJ TimerManager to delegate to.
void	setTimerManagerName(String timerManagerName)           Set the JNDI name of the CommonJ TimerManager.
void	start()           Resumes the underlying TimerManager (if not shared).
void	stop()           Suspends the underlying TimerManager (if not shared).

 

Methods inherited from class org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef

 

Methods inherited from class org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

TimerManagerFactoryBean

public TimerManagerFactoryBean()

setTimerManager

public void setTimerManager(commonj.timers.TimerManager timerManager)

Specify the CommonJ TimerManager to delegate to.

Note that the given TimerManager's lifecycle will be managed by this FactoryBean.

Alternatively (and typically), you can specify the JNDI name of the target TimerManager.

See Also:

setTimerManagerName(java.lang.String)

setTimerManagerName

public void setTimerManagerName(String timerManagerName)

Set the JNDI name of the CommonJ TimerManager.

This can either be a fully qualified JNDI name, or the JNDI name relative to the current environment naming context if "resourceRef" is set to "true".

See Also:

setTimerManager(commonj.timers.TimerManager), JndiLocatorSupport.setResourceRef(boolean)

setShared

public void setShared(boolean shared)

Specify whether the TimerManager obtained by this FactoryBean is a shared instance ("true") or an independent instance ("false"). The lifecycle of the former is supposed to be managed by the application server, while the lifecycle of the latter is up to the application.

Default is "false", i.e. managing an independent TimerManager instance. This is what the CommonJ specification suggests that application servers are supposed to offer via JNDI lookups, typically declared as a resource-ref of type commonj.timers.TimerManager in web.xml, with res-sharing-scope set to 'Unshareable'.

Switch this flag to "true" if you are obtaining a shared TimerManager, typically through specifying the JNDI location of a TimerManager that has been explicitly declared as 'Shareable'. Note that WebLogic's cluster-aware Job Scheduler is a shared TimerManager too.

The sole difference between this FactoryBean being in shared or non-shared mode is that it will only attempt to suspend / resume / stop the underlying TimerManager in case of an independent (non-shared) instance. This only affects the Lifecycle support as well as application context shutdown.

See Also:

stop(), start(), destroy(), TimerManager

public void setScheduledTimerListeners(ScheduledTimerListener[] scheduledTimerListeners)

public void afterPropertiesSet()
                        throws NamingException

public Object getObject()

public Class getObjectType()

public boolean isSingleton()

public void start()

public void stop()

public boolean isRunning()

public void destroy()