TimerImpl (WildFly: EJB Subsystem 26.0.1.Final API)

java.lang.Object
- org.jboss.as.ejb3.timerservice.TimerImpl

All Implemented Interfaces:

javax.ejb.Timer

Direct Known Subclasses:

CalendarTimer
```
public class TimerImpl
extends Object
implements javax.ejb.Timer
```
Implementation of Enterprise Beans 3.1 Timer

Version:

$Revision: $

Author:

Carlo de Wolf

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TimerImpl.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`TimerImpl.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`id` Unique id for this timer instance
`protected Serializable`	`info` The info which was passed while creating the timer.
`protected Date`	`initialExpiration` The initial (first) expiry date of this timer
`protected long`	`intervalDuration` The duration in milli sec.
`protected Date`	`nextExpiration` Next expiry date of this timer
`protected boolean`	`persistent` Indicates whether the timer is persistent
`protected Date`	`previousRun` The date of the previous run of this timer
`protected Object`	`primaryKey` If this is an entity bean then this is the primary key
`protected TimedObjectInvoker`	`timedObjectInvoker` The `TimedObjectInvoker` to which this timer corresponds
`protected TimerServiceImpl`	`timerService` The `TimerService` through which this timer was created
`protected TimerState`	`timerState` The timer state

Constructor Summary

Constructors
Modifier Constructor and Description

protected TimerImpl(TimerImpl.Builder builder, TimerServiceImpl service)
Creates a TimerImpl

Constructors
Modifier	Constructor and Description
`protected`	`TimerImpl(TimerImpl.Builder builder, TimerServiceImpl service)` Creates a `TimerImpl`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`assertTimerState()` Asserts that the timer is not in any of the following states: `TimerState.CANCELED` `TimerState.EXPIRED`
`static TimerImpl.Builder`	`builder()`
`void`	`cancel()`
`boolean`	`equals(Object o)`
`Serializable`	`getCachedTimerInfo()` Obtains the timer info cached in memory, without checking the persistent store.
`protected Thread`	`getExecutingThread()` Returns the executing thread which is processing the timeout task
`javax.ejb.TimerHandle`	`getHandle()`
`String`	`getId()` Returns the id of this timer
`Serializable`	`getInfo()`
`Date`	`getInitialExpiration()` Returns the initial (first) timeout date of this timer
`long`	`getInterval()` Returns the interval (in milliseconds), between timeouts, of this timer.
`Date`	`getNextExpiration()` This method is similar to `getNextTimeout()`, except that this method does not check the timer state and hence does not throw either `IllegalStateException` or `NoSuchObjectLocalException` or `EJBException`.
`Date`	`getNextTimeout()`
`Date`	`getPreviousRun()` Returns the `Date` of the previous timeout of this timer
`Object`	`getPrimaryKey()`
`javax.ejb.ScheduleExpression`	`getSchedule()`
`TimerState`	`getState()` Returns the current state of this timer
`String`	`getTimedObjectId()` Returns the timed object id to which this timer belongs
`long`	`getTimeRemaining()`
`Serializable`	`getTimerInfo()` This method is similar to `getInfo()`, except that this method does not check the timer state and hence does not throw either `IllegalStateException` or `NoSuchObjectLocalException` or `EJBException`.
`TimerServiceImpl`	`getTimerService()` Returns the timer service through which this timer was created
`protected TimerTask<?>`	`getTimerTask()` Returns the task which handles the timeouts of this `TimerImpl`
`int`	`hashCode()`
`void`	`invokeOneOff()` Triggers timer, outside of normal expiration.
`boolean`	`isActive()` Returns true if this timer is active.
`boolean`	`isAutoTimer()`
`boolean`	`isCalendarTimer()`
`boolean`	`isCanceled()` Returns true if this timer is in `TimerState.CANCELED` state.
`boolean`	`isExpired()` Returns true if this timer is in `TimerState.EXPIRED` state.
`boolean`	`isInRetry()` Returns true if this timer is in `TimerState.RETRY_TIMEOUT`.
`boolean`	`isPersistent()`
`void`	`lock()`
`void`	`scheduleTimeout(boolean newTimer)` Creates and schedules a `TimerTask` for the next timeout of this timer
`void`	`setCachedTimerInfo(Serializable newInfo)` Sets the timer info to a new value.
`void`	`setNextTimeout(Date next)` Sets the next timeout of this timer
`void`	`setPreviousRun(Date previousRun)` Sets the `Date` of the previous timeout of this timer
`void`	`setTimerState(TimerState state, Thread thread)` Sets the state and timer task executing thread of this timer
`void`	`suspend()` Suspends any currently scheduled task for this timer
`String`	`toString()` A nice formatted string output for this timer
`void`	`unlock()`

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

- Field Detail
  - id
```
protected final String id
```
    Unique id for this timer instance
  - timerState
```
protected volatile TimerState timerState
```
    The timer state
  - timerService
```
protected final TimerServiceImpl timerService
```
    The TimerService through which this timer was created
  - timedObjectInvoker
```
protected final TimedObjectInvoker timedObjectInvoker
```
    The TimedObjectInvoker to which this timer corresponds
  - info
```
protected Serializable info
```
    The info which was passed while creating the timer.
  - persistent
```
protected final boolean persistent
```
    Indicates whether the timer is persistent
  - initialExpiration
```
protected final Date initialExpiration
```
    The initial (first) expiry date of this timer
  - intervalDuration
```
protected final long intervalDuration
```
    The duration in milli sec. between timeouts
  - primaryKey
```
protected final Object primaryKey
```
    If this is an entity bean then this is the primary key
  - nextExpiration
```
protected volatile Date nextExpiration
```
    Next expiry date of this timer
  - previousRun
```
protected volatile Date previousRun
```
    The date of the previous run of this timer
- Constructor Detail
  - TimerImpl
```
protected TimerImpl(TimerImpl.Builder builder,
                    TimerServiceImpl service)
```
    Creates a TimerImpl
    
    Parameters:
    
    builder - The builder with the timer information
    
    service - The timer service through which this timer was created
- Method Detail
  - cancel
```
public void cancel()
            throws IllegalStateException,
                   javax.ejb.EJBException
```
    Specified by:
    
    cancel in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - getId
```
public String getId()
```
    Returns the id of this timer
    
    Returns:
  - isCalendarTimer
```
public boolean isCalendarTimer()
                        throws IllegalStateException,
                               javax.ejb.EJBException
```
    Specified by:
    
    isCalendarTimer in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - getHandle
```
public javax.ejb.TimerHandle getHandle()
                                throws IllegalStateException,
                                       javax.ejb.EJBException
```
    Specified by:
    
    getHandle in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - isPersistent
```
public boolean isPersistent()
                     throws IllegalStateException,
                            javax.ejb.EJBException
```
    Specified by:
    
    isPersistent in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - getInfo
```
public Serializable getInfo()
                     throws IllegalStateException,
                            javax.ejb.EJBException
```
    Specified by:
    
    getInfo in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
    
    See Also:
    
    getTimerInfo()
  - getTimerInfo
```
public Serializable getTimerInfo()
```
    This method is similar to getInfo(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.
    
    Returns:
    
    the timer info; if not available in-memory, retrieve it from persistence
  - getCachedTimerInfo
```
public Serializable getCachedTimerInfo()
```
    Obtains the timer info cached in memory, without checking the persistent store.
    
    Returns:
    
    the cached timer info
  - setCachedTimerInfo
```
public void setCachedTimerInfo(Serializable newInfo)
```
    Sets the timer info to a new value. The purpose of this method is for DatabaseTimerPersistence to reset the cached timer info. It should not be used for other purposes.
    
    Parameters:
    
    newInfo - the new timer info, typically null or an empty holder value
  - getNextTimeout
```
public Date getNextTimeout()
                    throws IllegalStateException,
                           javax.ejb.EJBException
```
    Specified by:
    
    getNextTimeout in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
    
    See Also:
    
    getNextExpiration()
  - getNextExpiration
```
public Date getNextExpiration()
```
    This method is similar to getNextTimeout(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.
    
    Returns:
  - setNextTimeout
```
public void setNextTimeout(Date next)
```
    Sets the next timeout of this timer
    
    Parameters:
    
    next - The next scheduled timeout of this timer
  - getSchedule
```
public javax.ejb.ScheduleExpression getSchedule()
                                         throws IllegalStateException,
                                                javax.ejb.EJBException
```
    Specified by:
    
    getSchedule in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - getTimeRemaining
```
public long getTimeRemaining()
                      throws IllegalStateException,
                             javax.ejb.EJBException
```
    Specified by:
    
    getTimeRemaining in interface javax.ejb.Timer
    
    Throws:
    
    IllegalStateException
    
    javax.ejb.EJBException
  - isAutoTimer
```
public boolean isAutoTimer()
```
  - getInitialExpiration
```
public Date getInitialExpiration()
```
    Returns the initial (first) timeout date of this timer
    
    Returns:
  - getInterval
```
public long getInterval()
```
    Returns the interval (in milliseconds), between timeouts, of this timer.
    
    Returns:
  - getTimedObjectId
```
public String getTimedObjectId()
```
    Returns the timed object id to which this timer belongs
    
    Returns:
  - getTimerService
```
public TimerServiceImpl getTimerService()
```
    Returns the timer service through which this timer was created
    
    Returns:
  - isActive
```
public boolean isActive()
```
    Returns true if this timer is active. Else returns false.
    A timer is considered to be "active", if its TimerState is neither of the following:
    - TimerState.CANCELED
    - TimerState.EXPIRED
    - has not been suspended
    And if the corresponding timer service is still up
    Returns:
  - isCanceled
```
public boolean isCanceled()
```
    Returns true if this timer is in TimerState.CANCELED state. Else returns false.
    
    Returns:
  - isExpired
```
public boolean isExpired()
```
    Returns true if this timer is in TimerState.EXPIRED state. Else returns false
    
    Returns:
  - isInRetry
```
public boolean isInRetry()
```
    Returns true if this timer is in TimerState.RETRY_TIMEOUT. Else returns false.
    
    Returns:
  - getPreviousRun
```
public Date getPreviousRun()
```
    Returns the Date of the previous timeout of this timer
    
    Returns:
  - setPreviousRun
```
public void setPreviousRun(Date previousRun)
```
    Sets the Date of the previous timeout of this timer
    
    Parameters:
    
    previousRun -
  - getState
```
public TimerState getState()
```
    Returns the current state of this timer
    
    Returns:
  - getExecutingThread
```
protected Thread getExecutingThread()
```
    Returns the executing thread which is processing the timeout task
    
    Returns:
    
    the executingThread
  - assertTimerState
```
protected void assertTimerState()
```
    Asserts that the timer is not in any of the following states:
    - TimerState.CANCELED
    - TimerState.EXPIRED
    Throws:
    
    javax.ejb.NoSuchObjectLocalException - if the txtimer was canceled or has expired
  - setTimerState
```
public void setTimerState(TimerState state,
                          Thread thread)
```
    Sets the state and timer task executing thread of this timer
    
    Parameters:
    
    state - The state of this timer
    
    thread - The executing thread which is processing the timeout task
  - suspend
```
public void suspend()
```
    Suspends any currently scheduled task for this timer
    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.
  - invokeOneOff
```
public void invokeOneOff()
                  throws Exception
```
    Triggers timer, outside of normal expiration. Only used when running an explicit management trigger operation. The tigger operation simply runs the callback, it does not modify the timer state in any way, and there is no protection against overlapping events when running it. This is the expected behaviour, as otherwise the semantics of dealing with concurrent execution is complex and kinda weird.
    
    Throws:
    
    Exception
  - scheduleTimeout
```
public void scheduleTimeout(boolean newTimer)
```
    Creates and schedules a TimerTask for the next timeout of this timer
    
    Parameters:
    
    newTimer - true if this is a new timer being scheduled, and not a re-schedule due to a timeout
  - getTimerTask
```
protected TimerTask<?> getTimerTask()
```
    Returns the task which handles the timeouts of this TimerImpl
    
    Returns:
    
    See Also:
    
    TimerTask
  - lock
```
public void lock()
          throws InterruptedException
```
    Throws:
    
    InterruptedException
  - unlock
```
public void unlock()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    A nice formatted string output for this timer
    
    Overrides:
    
    toString in class Object
  - getPrimaryKey
```
public Object getPrimaryKey()
```
  - builder
```
public static TimerImpl.Builder builder()
```

Class TimerImpl

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

timerState

timerService

timedObjectInvoker

info

persistent

initialExpiration

intervalDuration

primaryKey

nextExpiration

previousRun

Constructor Detail

TimerImpl

Method Detail

cancel

getId

isCalendarTimer

getHandle

isPersistent

getInfo

getTimerInfo

getCachedTimerInfo

setCachedTimerInfo

getNextTimeout

getNextExpiration

setNextTimeout

getSchedule

getTimeRemaining

isAutoTimer

getInitialExpiration

getInterval

getTimedObjectId

getTimerService

isActive

isCanceled

isExpired

isInRetry

getPreviousRun

setPreviousRun

getState

getExecutingThread

assertTimerState

setTimerState

suspend

invokeOneOff

scheduleTimeout

getTimerTask

lock

unlock

equals

hashCode

toString

getPrimaryKey

builder