org.jboss.as.ejb3.timerservice

Class TimerServiceImpl

java.lang.Object

org.jboss.as.ejb3.timerservice.TimerServiceImpl

All Implemented Interfaces:

javax.ejb.TimerService, org.jboss.msc.Service, org.jboss.msc.value.Value<javax.ejb.TimerService>

public class TimerServiceImpl
extends Object
implements javax.ejb.TimerService, org.jboss.msc.service.Service<javax.ejb.TimerService>

MK2 implementation of EJB3.1 TimerService

Version:

$Revision: $

Author:

Carlo de Wolf

Field Summary

Fields

Modifier and Type	Field and Description
static org.jboss.msc.service.ServiceName	SERVICE_NAME

Fields inherited from interface org.jboss.msc.service.Service

NULL, NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
TimerServiceImpl(Map<Method,List<AutoTimer>> autoTimers, org.jboss.msc.service.ServiceName serviceName) Deprecated. Use TimerServiceImpl(java.util.Map, org.jboss.msc.service.ServiceName, org.jboss.as.ejb3.component.TimerServiceRegistry) instead
TimerServiceImpl(Map<Method,List<AutoTimer>> autoTimers, org.jboss.msc.service.ServiceName serviceName, TimerServiceRegistry registry) Creates a TimerServiceImpl

Method Summary

Modifier and Type	Method and Description
void	activate()
protected void	cancelTimeout(TimerImpl timer) Cancels any scheduled Future corresponding to the passed timer
void	cancelTimer(TimerImpl timer)
javax.ejb.Timer	createCalendarTimer(javax.ejb.ScheduleExpression schedule)
javax.ejb.Timer	createCalendarTimer(javax.ejb.ScheduleExpression schedule, javax.ejb.TimerConfig timerConfig)
javax.ejb.Timer	createIntervalTimer(Date initialExpiration, long intervalDuration, javax.ejb.TimerConfig timerConfig)
javax.ejb.Timer	createIntervalTimer(long initialDuration, long intervalDuration, javax.ejb.TimerConfig timerConfig)
javax.ejb.Timer	createSingleActionTimer(Date expiration, javax.ejb.TimerConfig timerConfig)
javax.ejb.Timer	createSingleActionTimer(long duration, javax.ejb.TimerConfig timerConfig)
javax.ejb.Timer	createTimer(Date initialExpiration, long intervalDuration, Serializable info)
javax.ejb.Timer	createTimer(Date expiration, Serializable info)
javax.ejb.Timer	createTimer(long initialDuration, long intervalDuration, Serializable info)
javax.ejb.Timer	createTimer(long duration, Serializable info)
void	deactivate()
void	expireTimer(TimerImpl timer)
Collection<javax.ejb.Timer>	getAllTimers()
org.jboss.msc.value.InjectedValue<EJBComponent>	getEjbComponentInjectedValue()
org.jboss.msc.value.InjectedValue<ExecutorService>	getExecutorServiceInjectedValue()
TimedObjectInvoker	getInvoker() Returns the TimedObjectInvoker to which this timer service belongs
TimerServiceResource	getResource()
org.jboss.msc.service.ServiceName	getServiceName()
org.jboss.msc.value.InjectedValue<TimedObjectInvoker>	getTimedObjectInvoker()
TimerImpl	getTimer(String timerId)
TimerImpl	getTimer(javax.ejb.TimerHandle handle) Returns the Timer corresponding to the passed TimerHandle
org.jboss.msc.value.InjectedValue<Timer>	getTimerInjectedValue()
org.jboss.msc.value.InjectedValue<TimerPersistence>	getTimerPersistence()
Collection<javax.ejb.Timer>	getTimers()
protected Transaction	getTransaction()
javax.ejb.TimerService	getValue()
protected boolean	isLifecycleCallbackInvocation() Returns true if the CurrentInvocationContext represents a lifecycle callback invocation.
boolean	isScheduled(String tid)
boolean	isStarted()
TimerImpl	loadAutoTimer(javax.ejb.ScheduleExpression schedule, javax.ejb.TimerConfig timerConfig, Method timeoutMethod)
void	persistTimer(TimerImpl timer, boolean newTimer) Persists the passed timer.
void	restoreTimers(List<ScheduleTimer> autoTimers) Restores persisted timers, corresponding to this timerservice, which are eligible for any new timeouts.
protected void	scheduleTimeout(TimerImpl timer, boolean newTimer) Creates and schedules a TimerTask for the next timeout of the passed timer
boolean	shouldRun(TimerImpl timer) Check if a persistent timer is already executed from a different instance or should be executed.
void	start(org.jboss.msc.service.StartContext context)
protected void	startTimer(TimerImpl timer) Registers a timer with a transaction (if any in progress) and then moves the timer to an active state, so that it becomes eligible for timeouts
void	stop(org.jboss.msc.service.StopContext context)
void	suspendTimers() Suspends any currently scheduled tasks for Timers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.msc.Service

newInstance

Field Detail

SERVICE_NAME

public static final org.jboss.msc.service.ServiceName SERVICE_NAME

Constructor Detail

TimerServiceImpl

@Deprecated
public TimerServiceImpl(Map<Method,List<AutoTimer>> autoTimers,
                                    org.jboss.msc.service.ServiceName serviceName)

Deprecated. Use TimerServiceImpl(java.util.Map, org.jboss.msc.service.ServiceName, org.jboss.as.ejb3.component.TimerServiceRegistry) instead

Creates a TimerServiceImpl

Parameters:

autoTimers -

serviceName -

Throws:

IllegalArgumentException - If either of the passed param is null

TimerServiceImpl

public TimerServiceImpl(Map<Method,List<AutoTimer>> autoTimers,
                        org.jboss.msc.service.ServiceName serviceName,
                        TimerServiceRegistry registry)

Creates a TimerServiceImpl

Parameters:

autoTimers - The auto timers associated with this timer service

serviceName - The service name of this timer service

registry - The TimerServiceRegistry which has the knowledge of other timer services belonging to the EJB module to which this timer service belongs.

Method Detail

start

public void start(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException

Specified by:

start in interface org.jboss.msc.Service

Throws:

org.jboss.msc.service.StartException

stop

public void stop(org.jboss.msc.service.StopContext context)

Specified by:

stop in interface org.jboss.msc.Service

activate

public void activate()

deactivate

public void deactivate()

getValue

public javax.ejb.TimerService getValue()
                                throws IllegalStateException,
                                       IllegalArgumentException

Specified by:

getValue in interface org.jboss.msc.value.Value<javax.ejb.TimerService>

Throws:

IllegalStateException

IllegalArgumentException

createCalendarTimer

public javax.ejb.Timer createCalendarTimer(javax.ejb.ScheduleExpression schedule)
                                    throws IllegalArgumentException,
                                           IllegalStateException,
                                           javax.ejb.EJBException

Specified by:

createCalendarTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createCalendarTimer

public javax.ejb.Timer createCalendarTimer(javax.ejb.ScheduleExpression schedule,
                                           javax.ejb.TimerConfig timerConfig)
                                    throws IllegalArgumentException,
                                           IllegalStateException,
                                           javax.ejb.EJBException

Specified by:

createCalendarTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createIntervalTimer

public javax.ejb.Timer createIntervalTimer(Date initialExpiration,
                                           long intervalDuration,
                                           javax.ejb.TimerConfig timerConfig)
                                    throws IllegalArgumentException,
                                           IllegalStateException,
                                           javax.ejb.EJBException

Specified by:

createIntervalTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createIntervalTimer

public javax.ejb.Timer createIntervalTimer(long initialDuration,
                                           long intervalDuration,
                                           javax.ejb.TimerConfig timerConfig)
                                    throws IllegalArgumentException,
                                           IllegalStateException,
                                           javax.ejb.EJBException

Specified by:

createIntervalTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createSingleActionTimer

public javax.ejb.Timer createSingleActionTimer(Date expiration,
                                               javax.ejb.TimerConfig timerConfig)
                                        throws IllegalArgumentException,
                                               IllegalStateException,
                                               javax.ejb.EJBException

Specified by:

createSingleActionTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createSingleActionTimer

public javax.ejb.Timer createSingleActionTimer(long duration,
                                               javax.ejb.TimerConfig timerConfig)
                                        throws IllegalArgumentException,
                                               IllegalStateException,
                                               javax.ejb.EJBException

Specified by:

createSingleActionTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createTimer

public javax.ejb.Timer createTimer(long duration,
                                   Serializable info)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.ejb.EJBException

Specified by:

createTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createTimer

public javax.ejb.Timer createTimer(Date expiration,
                                   Serializable info)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.ejb.EJBException

Specified by:

createTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createTimer

public javax.ejb.Timer createTimer(long initialDuration,
                                   long intervalDuration,
                                   Serializable info)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.ejb.EJBException

Specified by:

createTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

createTimer

public javax.ejb.Timer createTimer(Date initialExpiration,
                                   long intervalDuration,
                                   Serializable info)
                            throws IllegalArgumentException,
                                   IllegalStateException,
                                   javax.ejb.EJBException

Specified by:

createTimer in interface javax.ejb.TimerService

Throws:

IllegalArgumentException

IllegalStateException

javax.ejb.EJBException

loadAutoTimer

public TimerImpl loadAutoTimer(javax.ejb.ScheduleExpression schedule,
                               javax.ejb.TimerConfig timerConfig,
                               Method timeoutMethod)

getTimers

public Collection<javax.ejb.Timer> getTimers()
                                      throws IllegalStateException,
                                             javax.ejb.EJBException

Specified by:

getTimers in interface javax.ejb.TimerService

Throws:

IllegalStateException

javax.ejb.EJBException

getAllTimers

public Collection<javax.ejb.Timer> getAllTimers()
                                         throws IllegalStateException,
                                                javax.ejb.EJBException

Specified by:

getAllTimers in interface javax.ejb.TimerService

Throws:

IllegalStateException

javax.ejb.EJBException

getTimer

public TimerImpl getTimer(String timerId)

getInvoker

public TimedObjectInvoker getInvoker()

Returns the TimedObjectInvoker to which this timer service belongs

Returns:

getTimer

public TimerImpl getTimer(javax.ejb.TimerHandle handle)

Returns the Timer corresponding to the passed TimerHandle

Parameters:

handle - The TimerHandle for which the Timer is being looked for

getTransaction

protected Transaction getTransaction()

Returns:

Returns the current transaction, if any. Else returns null.

Throws:

javax.ejb.EJBException - If there is any system level exception

persistTimer

public void persistTimer(TimerImpl timer,
                         boolean newTimer)

Persists the passed timer.

If the passed timer is null or is non-persistent (i.e. Timer.isPersistent() returns false), then this method acts as a no-op

Parameters:

timer -

cancelTimer

public void cancelTimer(TimerImpl timer)
                 throws InterruptedException

Throws:

InterruptedException

expireTimer

public void expireTimer(TimerImpl timer)

suspendTimers

public void suspendTimers()

Suspends any currently scheduled tasks for Timers

Note that, suspend does not cancel the Timer. Instead, it just cancels the next scheduled timeout. So once the Timer is restored (whenever that happens), the Timer will continue to timeout at appropriate times.

restoreTimers

public void restoreTimers(List<ScheduleTimer> autoTimers)

Restores persisted timers, corresponding to this timerservice, which are eligible for any new timeouts.

This includes timers whose TimerState is neither of the following:

• TimerState.CANCELED
• TimerState.EXPIRED

All such restored timers will be schedule for their next timeouts.

Parameters:

autoTimers -

startTimer

protected void startTimer(TimerImpl timer)

Registers a timer with a transaction (if any in progress) and then moves the timer to an active state, so that it becomes eligible for timeouts

isLifecycleCallbackInvocation

protected boolean isLifecycleCallbackInvocation()

Returns true if the CurrentInvocationContext represents a lifecycle callback invocation. Else returns false.

This method internally relies on CurrentInvocationContext.get() to obtain the current invocation context.

• If the context is available then it looks for the method that was invoked. The absence of a method indicates a lifecycle callback.
• If the context is not available, then this method returns false (i.e. it doesn't consider the current invocation as a lifecycle callback). This is for convenience, to allow the invocation of TimerService methods in the absence of CurrentInvocationContext

Returns:

scheduleTimeout

protected void scheduleTimeout(TimerImpl timer,
                               boolean newTimer)

Creates and schedules a TimerTask for the next timeout of the passed timer

cancelTimeout

protected void cancelTimeout(TimerImpl timer)

Cancels any scheduled Future corresponding to the passed timer

Parameters:

timer -

isScheduled

public boolean isScheduled(String tid)

getEjbComponentInjectedValue

public org.jboss.msc.value.InjectedValue<EJBComponent> getEjbComponentInjectedValue()

getExecutorServiceInjectedValue

public org.jboss.msc.value.InjectedValue<ExecutorService> getExecutorServiceInjectedValue()

getTimerInjectedValue

public org.jboss.msc.value.InjectedValue<Timer> getTimerInjectedValue()

getTimerPersistence

public org.jboss.msc.value.InjectedValue<TimerPersistence> getTimerPersistence()

getServiceName

public org.jboss.msc.service.ServiceName getServiceName()

isStarted

public boolean isStarted()

getTimedObjectInvoker

public org.jboss.msc.value.InjectedValue<TimedObjectInvoker> getTimedObjectInvoker()

getResource

public TimerServiceResource getResource()

shouldRun

public boolean shouldRun(TimerImpl timer)

Check if a persistent timer is already executed from a different instance or should be executed. For non-persistent timer it always return true.

Parameters:

timer - the timer which should be checked

Returns:

true if the timer is not persistent or the persistent timer should start