org.jboss.ejb.txtimer
Interface PersistencePolicy

All Known Subinterfaces:

DatabasePersistencePolicyMBean, NoopPersistencePolicyMBean

All Known Implementing Classes:

DatabasePersistencePolicy, NoopPersistencePolicy

public interface PersistencePolicy

Timers are persistent objects. In the event of a container crash, any single-event timers that have expired during the intervening time before container restart must cause the ejbTimeout method to be invoked upon restart. Any interval timers that have expired during the intervening time must cause the ejb- Timeout method to be invoked at least once upon restart.

Since:

09-Sep-2004

Version:

$Revision: 1.4.2.5 $

Author:

Thomas.Diesler@jboss.org, Dimitris.Andreadis@jboss.org

Method Summary

void	clearTimers() Clear the persisted timers
void	deleteTimer(String timerId, TimedObjectId timedObjectId) Deletes a timer from persistent storage.
void	insertTimer(String timerId, TimedObjectId targetId, Date firstEvent, long periode, Serializable info) Inserts a timer into persistent storage.
List	listTimerHandles() List all the persisted timer handles
List	listTimerHandles(javax.management.ObjectName containerId, ClassLoader loader) List the persisted timer handles for a particular container

Method Detail

insertTimer

void insertTimer(String timerId,
                 TimedObjectId targetId,
                 Date firstEvent,
                 long periode,
                 Serializable info)

Inserts a timer into persistent storage.

Parameters:

timerId - The timer id

targetId - The timed object id

firstEvent - The point in time at which the first txtimer expiration must occur.

periode - The number of milliseconds that must elapse between txtimer expiration notifications.

info - A serializable handback object.

deleteTimer

void deleteTimer(String timerId,
                 TimedObjectId timedObjectId)

Deletes a timer from persistent storage.

Parameters:

timerId - The timer id

timedObjectId - The id of the timed object

listTimerHandles

List listTimerHandles(javax.management.ObjectName containerId,
                      ClassLoader loader)

List the persisted timer handles for a particular container

Parameters:

containerId - The Container ObjectName

loader - The ClassLoader to use for loading the handles

Returns:

a list of TimerHandleImpl objects

listTimerHandles

List listTimerHandles()

List all the persisted timer handles

Returns:

a list of TimerHandleImpl objects

clearTimers

void clearTimers()

Clear the persisted timers