|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.jndi.JndiAccessor org.springframework.jndi.JndiLocatorSupport org.springframework.scheduling.commonj.TimerManagerFactoryBean
public class TimerManagerFactoryBean
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.
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 |
---|
public TimerManagerFactoryBean()
Method Detail |
---|
public void setTimerManager(commonj.timers.TimerManager timerManager)
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(java.lang.String)
public void setTimerManagerName(String timerManagerName)
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".
setTimerManager(commonj.timers.TimerManager)
,
JndiLocatorSupport.setResourceRef(boolean)
public void setShared(boolean shared)
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
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
resource-ref
of type commonj.timers.TimerManager
in web.xml
, with
res-sharing-scope
set to 'Unshareable'.
Lifecycle
support
as well as application context shutdown.
public void setScheduledTimerListeners(ScheduledTimerListener[] scheduledTimerListeners)
TimerManager.schedule(commonj.timers.TimerListener, long)
,
TimerManager.schedule(commonj.timers.TimerListener, long, long)
,
TimerManager.scheduleAtFixedRate(commonj.timers.TimerListener, long, long)
public void afterPropertiesSet() throws NamingException
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
NamingException
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
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.
NOTE: This method returning false
does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean
interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype()
method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton()
implementation returns false
.
isSingleton
in interface FactoryBean
FactoryBean.getObject()
,
SmartFactoryBean.isPrototype()
public void start()
start
in interface Lifecycle
TimerManager.resume()
public void stop()
stop
in interface Lifecycle
TimerManager.suspend()
public boolean isRunning()
isRunning
in interface Lifecycle
TimerManager.isSuspending()
,
TimerManager.isStopping()
public void destroy()
destroy
in interface DisposableBean
Timer.cancel()
,
TimerManager.stop()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |