Package org.jboss.as.ejb3.timerservice.distributable

Class OOBTimer<I>

java.lang.Object

org.jboss.as.ejb3.timerservice.distributable.OOBTimer<I>

Type Parameters:

I - the timer identifier type

All Implemented Interfaces:

jakarta.ejb.Timer, ManagedTimer

public class OOBTimer<I>
extends Object
implements ManagedTimer

Timer implementation for use outside the context of a timeout event. Ensures that all timer methods are invoked within the context of a batch.

Author:

Paul Ferraro

Constructor Summary

Constructors

Constructor	Description
OOBTimer(TimerManager<I,Batch> manager, I id, TimedObjectInvoker invoker, TimerSynchronizationFactory<I> synchronizationFactory)

Method Summary

Modifier and Type	Method	Description
void	activate()	Activates a previously suspended timer.
void	cancel()
boolean	equals(Object object)
jakarta.ejb.TimerHandle	getHandle()
String	getId()	The unique identifier of this timer.
Serializable	getInfo()
Date	getNextTimeout()
jakarta.ejb.ScheduleExpression	getSchedule()
long	getTimeRemaining()
int	hashCode()
void	invoke()	Invokes the timeout method associated with this timer.
boolean	isActive()	Indicates whether this timer is active, i.e. not suspended.
boolean	isCalendarTimer()
boolean	isCanceled()	Indicates whether this timer was canceled, i.e. via Timer.cancel().
boolean	isExpired()	Indicates whether this timer has expired, i.e. it has no more timeouts.
boolean	isPersistent()
void	suspend()	Suspends a previously active timer.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.ejb3.timerservice.spi.ManagedTimer

validateInvocationContext

Constructor Details

OOBTimer

public OOBTimer(TimerManager<I,Batch> manager,
 I id,
 TimedObjectInvoker invoker,
 TimerSynchronizationFactory<I> synchronizationFactory)

Method Details

cancel

public void cancel()

Specified by:

cancel in interface jakarta.ejb.Timer

getTimeRemaining

public long getTimeRemaining()

Specified by:

getTimeRemaining in interface jakarta.ejb.Timer

getNextTimeout

public Date getNextTimeout()

Specified by:

getNextTimeout in interface jakarta.ejb.Timer

getSchedule

public jakarta.ejb.ScheduleExpression getSchedule()

Specified by:

getSchedule in interface jakarta.ejb.Timer

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface jakarta.ejb.Timer

isCalendarTimer

public boolean isCalendarTimer()

Specified by:

isCalendarTimer in interface jakarta.ejb.Timer

getInfo

public Serializable getInfo()

Specified by:

getInfo in interface jakarta.ejb.Timer

getHandle

public jakarta.ejb.TimerHandle getHandle()

Specified by:

getHandle in interface jakarta.ejb.Timer

getId

public String getId()

Description copied from interface: ManagedTimer

The unique identifier of this timer.

Specified by:

getId in interface ManagedTimer

Returns:

a unique identifier

activate

public void activate()

Description copied from interface: ManagedTimer

Activates a previously suspended timer. Once active, the timer will receive timeout events as usual, including any timeouts missed while inactive.

Specified by:

activate in interface ManagedTimer

suspend

public void suspend()

Description copied from interface: ManagedTimer

Suspends a previously active timer. While suspended, the timer will not receive timeout events.

Specified by:

suspend in interface ManagedTimer

invoke

public void invoke()
            throws Exception

Description copied from interface: ManagedTimer

Invokes the timeout method associated with this timer. Has no impact on this timer's schedule.

Specified by:

invoke in interface ManagedTimer

Throws:

Exception

isActive

public boolean isActive()

Description copied from interface: ManagedTimer

Indicates whether this timer is active, i.e. not suspended.

Specified by:

isActive in interface ManagedTimer

Returns:

true, if this timer is active, false otherwise.

isCanceled

public boolean isCanceled()

Description copied from interface: ManagedTimer

Indicates whether this timer was canceled, i.e. via Timer.cancel().

Specified by:

isCanceled in interface ManagedTimer

Returns:

true, if this timer was canceled, false otherwise.

isExpired

public boolean isExpired()

Description copied from interface: ManagedTimer

Indicates whether this timer has expired, i.e. it has no more timeouts. An interval timer will always return false.

Specified by:

isExpired in interface ManagedTimer

Returns:

true, if this timer has expired, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object