org.jboss.as.ejb3.timerservice

Class CalendarTimer

java.lang.Object

org.jboss.as.ejb3.timerservice.TimerImpl

org.jboss.as.ejb3.timerservice.CalendarTimer

All Implemented Interfaces:

javax.ejb.Timer

public class CalendarTimer
extends TimerImpl

Represents a Timer which is created out a calendar expression

Version:

$Revision: $

Author:

Jaikiran Pai

Field Summary

Fields inherited from class org.jboss.as.ejb3.timerservice.TimerImpl

handle, id, info, initialExpiration, intervalDuration, nextExpiration, persistent, previousRun, primaryKey, timedObjectInvoker, timerService, timerState

Constructor Summary

Constructors

Constructor and Description
CalendarTimer(CalendarTimerEntity persistedCalendarTimer, TimerServiceImpl timerService) Constructs a CalendarTimer from a persistent state
CalendarTimer(String id, TimerServiceImpl timerService, CalendarBasedTimeout calendarTimeout, Object primaryKey) Constructs a CalendarTimer
CalendarTimer(String id, TimerServiceImpl timerService, CalendarBasedTimeout calendarTimeout, Serializable info, boolean persistent, Method timeoutMethod, Object primaryKey) Constructs a CalendarTimer
CalendarTimer(String id, TimerServiceImpl timerService, CalendarBasedTimeout calendarTimeout, Serializable info, boolean persistent, Object primaryKey) Constructs a CalendarTimer

Method Summary

Methods

Modifier and Type	Method and Description
protected TimerEntity	createPersistentState() Creates and return a new persistent state of this timer
boolean	equals(Object obj) A Timer is equal to another Timer if their TimerHandles are equal
CalendarBasedTimeout	getCalendarTimeout() Returns the CalendarBasedTimeout corresponding to this CalendarTimer
javax.ejb.ScheduleExpression	getSchedule()
javax.ejb.ScheduleExpression	getScheduleExpression() This method is similar to getSchedule(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.
Method	getTimeoutMethod()
protected TimerTask<?>	getTimerTask() Returns the task which handles the timeouts on this CalendarTimer
int	hashCode()
boolean	isAutoTimer() Returns true if this is an auto-timer.
boolean	isCalendarTimer()

Methods inherited from class org.jboss.as.ejb3.timerservice.TimerImpl

assertTimerState, cancel, cancelTimeout, expireTimer, getHandle, getId, getInfo, getInitialExpiration, getInterval, getNextExpiration, getNextTimeout, getPersistentState, getPreviousRun, getPrimaryKey, getState, getTimedObjectId, getTimeRemaining, getTimerHandle, getTimerInfo, getTimerService, isActive, isCanceled, isExpired, isInRetry, isPersistent, scheduleTimeout, setNextTimeout, setPreviousRun, setTimerState, suspend, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CalendarTimer

public CalendarTimer(String id,
             TimerServiceImpl timerService,
             CalendarBasedTimeout calendarTimeout,
             Object primaryKey)

Constructs a CalendarTimer

Parameters:

id - The id of this timer

timerService - The timer service to which this timer belongs

calendarTimeout - The CalendarBasedTimeout from which this CalendarTimer is being created

CalendarTimer

public CalendarTimer(String id,
             TimerServiceImpl timerService,
             CalendarBasedTimeout calendarTimeout,
             Serializable info,
             boolean persistent,
             Object primaryKey)

Constructs a CalendarTimer

Parameters:

id - The id of this timer

timerService - The timer service to which this timer belongs

calendarTimeout - The CalendarBasedTimeout from which this CalendarTimer is being created

info - The serializable info which will be made available through Timer.getInfo()

persistent - True if this timer is persistent. False otherwise

CalendarTimer

public CalendarTimer(String id,
             TimerServiceImpl timerService,
             CalendarBasedTimeout calendarTimeout,
             Serializable info,
             boolean persistent,
             Method timeoutMethod,
             Object primaryKey)

Constructs a CalendarTimer

Parameters:

id - The id of this timer

timerService - The timer service to which this timer belongs

calendarTimeout - The CalendarBasedTimeout from which this CalendarTimer is being created

info - The serializable info which will be made available through Timer.getInfo()

persistent - True if this timer is persistent. False otherwise

timeoutMethod - If this is a non-null value, then this CalendarTimer is marked as an auto-timer. This timeoutMethod is then considered as the name of the timeout method which has to be invoked when this timer times out.

CalendarTimer

public CalendarTimer(CalendarTimerEntity persistedCalendarTimer,
             TimerServiceImpl timerService)

Constructs a CalendarTimer from a persistent state

Parameters:

persistedCalendarTimer - The persistent state of the calendar timer

timerService - The timer service to which this timer belongs

Method Detail

getSchedule

public javax.ejb.ScheduleExpression getSchedule()
                                         throws IllegalStateException,
                                                javax.ejb.EJBException

Specified by:

getSchedule in interface javax.ejb.Timer

Overrides:

getSchedule in class TimerImpl

Throws:

IllegalStateException

javax.ejb.EJBException

See Also:

getScheduleExpression()

getScheduleExpression

public javax.ejb.ScheduleExpression getScheduleExpression()

This method is similar to getSchedule(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.

Returns:

isCalendarTimer

public boolean isCalendarTimer()
                        throws IllegalStateException,
                               javax.ejb.EJBException

Specified by:

isCalendarTimer in interface javax.ejb.Timer

Overrides:

isCalendarTimer in class TimerImpl

Throws:

IllegalStateException

javax.ejb.EJBException

createPersistentState

protected TimerEntity createPersistentState()

Creates and return a new persistent state of this timer

Overrides:

createPersistentState in class TimerImpl

Returns:

getCalendarTimeout

public CalendarBasedTimeout getCalendarTimeout()

Returns the CalendarBasedTimeout corresponding to this CalendarTimer

Returns:

isAutoTimer

public boolean isAutoTimer()

Returns true if this is an auto-timer. Else returns false.

Overrides:

isAutoTimer in class TimerImpl

getTimerTask

protected TimerTask<?> getTimerTask()

Returns the task which handles the timeouts on this CalendarTimer

Overrides:

getTimerTask in class TimerImpl

Returns:

See Also:

CalendarTimerTask

getTimeoutMethod

public Method getTimeoutMethod()

hashCode

public int hashCode()

Overrides:

hashCode in class TimerImpl

equals

public boolean equals(Object obj)

A Timer is equal to another Timer if their TimerHandles are equal

Overrides:

equals in class TimerImpl