Class TimerManagerAccessor
- java.lang.Object
- org.springframework.jndi.JndiAccessor
- org.springframework.jndi.JndiLocatorSupport
- org.springframework.scheduling.commonj.TimerManagerAccessor
- All Implemented Interfaces:
DisposableBean,InitializingBean,Lifecycle
- Direct Known Subclasses:
TimerManagerFactoryBean,TimerManagerTaskScheduler
@Deprecated public abstract class TimerManagerAccessor extends JndiLocatorSupport implements InitializingBean, DisposableBean, Lifecycle
Deprecated.as of 5.1, in favor of EE 7'sDefaultManagedTaskSchedulerBase class for classes that are accessing a CommonJTimerManagerDefines common configuration settings and common lifecycle handling.- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
TimerManager
Field Summary
Fields inherited from class org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
Fields inherited from class org.springframework.jndi.JndiAccessor
logger
Constructor Summary
Constructors Constructor Description TimerManagerAccessor()Deprecated.
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidafterPropertiesSet()Deprecated.Invoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.voiddestroy()Deprecated.Stops the underlying TimerManager (if not shared).protected TimerManagergetTimerManager()Deprecated.Return the configured TimerManager, if any.booleanisRunning()Deprecated.Considers the underlying TimerManager as running if it is neither suspending nor stopping.protected TimerManagerobtainTimerManager()Deprecated.Obtain the TimerManager for actual use.voidsetShared(boolean shared)Deprecated.Specify whether the TimerManager obtained by this FactoryBean is a shared instance ("true") or an independent instance ("false").voidsetTimerManager(TimerManager timerManager)Deprecated.Specify the CommonJ TimerManager to delegate to.voidsetTimerManagerName(String timerManagerName)Deprecated.Set the JNDI name of the CommonJ TimerManager.voidstart()Deprecated.Resumes the underlying TimerManager (if not shared).voidstop()Deprecated.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
Constructor Detail
TimerManagerAccessor
public TimerManagerAccessor()
Deprecated.
Method Detail
setTimerManager
public void setTimerManager(TimerManager timerManager)
Deprecated.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.
setTimerManagerName
public void setTimerManagerName(String timerManagerName)
Deprecated.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".
setShared
public void setShared(boolean shared)
Deprecated.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-refof typecommonj.timers.TimerManagerinweb.xml, withres-sharing-scopeset 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
Lifecyclesupport as well as application context shutdown.- See Also:
stop(),start(),destroy(),TimerManager
afterPropertiesSet
public void afterPropertiesSet() throws NamingException
Deprecated.Description copied from interface:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
- Specified by:
afterPropertiesSetin interfaceInitializingBean- Throws:
NamingException
getTimerManager
@Nullable protected final TimerManager getTimerManager()
Deprecated.Return the configured TimerManager, if any.- Returns:
- the TimerManager, or
nullif not available
obtainTimerManager
protected TimerManager obtainTimerManager()
Deprecated.Obtain the TimerManager for actual use.- Returns:
- the TimerManager (never
null) - Throws:
IllegalStateException- in case of no TimerManager set- Since:
- 5.0
start
public void start()
Deprecated.Resumes the underlying TimerManager (if not shared).- Specified by:
startin interfaceLifecycle- See Also:
TimerManager.resume()
stop
public void stop()
Deprecated.Suspends the underlying TimerManager (if not shared).- Specified by:
stopin interfaceLifecycle- See Also:
TimerManager.suspend()
isRunning
public boolean isRunning()
Deprecated.Considers the underlying TimerManager as running if it is neither suspending nor stopping.- Specified by:
isRunningin interfaceLifecycle- Returns:
- whether the component is currently running
- See Also:
TimerManager.isSuspending(),TimerManager.isStopping()
destroy
public void destroy()
Deprecated.Stops the underlying TimerManager (if not shared).- Specified by:
destroyin interfaceDisposableBean- See Also:
TimerManager.stop()