Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas_ejb.container.JTimerService Class Reference

Collaboration diagram for org.objectweb.jonas_ejb.container.JTimerService:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 JTimerService (JFactory bf)
 JTimerService (JEntitySwitch es)
TransactionManager getTransactionManager ()
void notify (Timer timer)
void remove (Timer timer)
void cancelAllTimers ()
Timer getTimer (long initialDuration, long intervalDuration, Serializable info)
Timer createTimer (Date initialExpiration, long intervalDuration, Serializable info) throws IllegalArgumentException, IllegalStateException, EJBException
Timer createTimer (Date expiration, Serializable info) throws IllegalArgumentException, IllegalStateException, EJBException
Timer createTimer (long initialDuration, long intervalDuration, Serializable info) throws IllegalArgumentException, IllegalStateException, EJBException
Timer createTimer (long duration, Serializable info) throws IllegalArgumentException, IllegalStateException, EJBException
Collection getTimers () throws IllegalStateException, EJBException
String getEjbName ()
Serializable getPK ()
String getContainer ()

Detailed Description

JOnAS Implementation of the TimerService interface (from EJB 2.1) One such object is created the first time a bean calls getTimerService. Basically manages the list of the Timers for that bean.
Author:
Philippe Durieux

Definition at line 52 of file JTimerService.java.

Constructor & Destructor Documentation

org.objectweb.jonas_ejb.container.JTimerService.JTimerService (  JFactory  bf  ) 
 

constructor used for MDB or Session beans

Definition at line 65 of file JTimerService.java.

References org.objectweb.jonas.jtm.TransactionService.getTransactionManager().

Here is the call graph for this function:

org.objectweb.jonas_ejb.container.JTimerService.JTimerService (  JEntitySwitch  es  ) 
 

constructor used for Entity beans

Definition at line 80 of file JTimerService.java.

References org.objectweb.jonas.jtm.TransactionService.getTransactionManager().

Here is the call graph for this function:

Member Function Documentation

void org.objectweb.jonas_ejb.container.JTimerService.cancelAllTimers (   ) 
 

cancel all timers (when entity bean is removed)

Definition at line 138 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JTimer.stopTimer().

Here is the call graph for this function:

Timer org.objectweb.jonas_ejb.container.JTimerService.createTimer (  long  duration,
Serializable  info
)  throws IllegalArgumentException, IllegalStateException, EJBException
 

Create a single-action timer that expires after a specified duration.

Parameters:
duration The number of milliseconds that must elapse before the timer expires.
info Application information to be delivered along with the timer expiration. This can be null.
Returns:
the newly created Timer.
Exceptions:
IllegalArgumentException initialExpiration = 0, or intervalDuration < 0.
IllegalStateException the instance is in a state that does not allow access to this method.
EJBException If this method could not complete due to a system-level failure.

Definition at line 273 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JTimerService.createTimer().

Here is the call graph for this function:

Timer org.objectweb.jonas_ejb.container.JTimerService.createTimer (  long  initialDuration,
long  intervalDuration,
Serializable  info
)  throws IllegalArgumentException, IllegalStateException, EJBException
 

Create an interval timer whose first expiration occurs after a specified duration, and whose subsequent expirations occur after a specified interval.

Parameters:
initialDuration The number of milliseconds that must elapse before the first timer expiration notification.
intervalDuration The number of milliseconds that must elapse between timer expiration notifications.
info Application information to be delivered along with the timer expiration. This can be null.
Returns:
the newly created Timer.
Exceptions:
IllegalArgumentException initialExpiration = 0, or intervalDuration < 0.
IllegalStateException the instance is in a state that does not allow access to this method.
EJBException If this method could not complete due to a system-level failure.

Definition at line 234 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntitySwitch.getPrimaryKey(), and org.objectweb.jonas_ejb.container.JTimer.startTimer().

Here is the call graph for this function:

Timer org.objectweb.jonas_ejb.container.JTimerService.createTimer (  Date  expiration,
Serializable  info
)  throws IllegalArgumentException, IllegalStateException, EJBException
 

Create a single-action timer that expires at a given point in time.

Parameters:
expiration The point in time at which the timer expiration must occur.
info Application information to be delivered along with the timer expiration. This can be null.
Returns:
the newly created Timer.
Exceptions:
IllegalArgumentException expiration = 0, or expiration.getTime() < 0.
IllegalStateException the instance is in a state that does not allow access to this method.
EJBException If this method could not complete due to a system-level failure.

Definition at line 211 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JTimerService.createTimer().

Here is the call graph for this function:

Timer org.objectweb.jonas_ejb.container.JTimerService.createTimer (  Date  initialExpiration,
long  intervalDuration,
Serializable  info
)  throws IllegalArgumentException, IllegalStateException, EJBException
 

Create an interval timer whose first expiration occurs at a given point in time and whose subsequent expirations occur after a specified interval.

Parameters:
initialExpiration The point in time at which the first timer expiration must occur.
intervalDuration The number of milliseconds that must elapse between timer expiration notifications.
info Application information to be delivered along with the timer expiration. This can be null.
Returns:
the newly created Timer.
Exceptions:
IllegalArgumentException initialExpiration = 0, or intervalDuration < 0 or initialExpiration.getTime() < 0.
IllegalStateException the instance is in a state that does not allow access to this method.
EJBException If this method could not complete due to a system-level failure.

Definition at line 187 of file JTimerService.java.

Referenced by org.objectweb.jonas_ejb.container.JTimerService.createTimer().

String org.objectweb.jonas_ejb.container.JTimerService.getContainer (   ) 
 

Returns:
the Container File Name

Definition at line 326 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntitySwitch.getBeanFactory(), org.objectweb.jonas_ejb.container.JFactory.getContainer(), and org.objectweb.jonas_ejb.container.JContainer.getExternalFileName().

Referenced by org.objectweb.jonas_ejb.container.JTimer.getHandle().

Here is the call graph for this function:

String org.objectweb.jonas_ejb.container.JTimerService.getEjbName (   ) 
 

Returns:
the EjbName used to retrieve the bean factory

Definition at line 297 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntitySwitch.getBeanFactory(), and org.objectweb.jonas_ejb.container.JFactory.getEJBName().

Referenced by org.objectweb.jonas_ejb.container.JTimer.getHandle().

Here is the call graph for this function:

Serializable org.objectweb.jonas_ejb.container.JTimerService.getPK (   ) 
 

Returns:
the encoded PK for entity bean timers

Definition at line 310 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntityFactory.encodePK(), org.objectweb.jonas_ejb.container.JEntitySwitch.getBeanFactory(), and org.objectweb.jonas_ejb.container.JEntitySwitch.getPrimaryKey().

Referenced by org.objectweb.jonas_ejb.container.JTimer.getHandle().

Here is the call graph for this function:

Timer org.objectweb.jonas_ejb.container.JTimerService.getTimer (  long  initialDuration,
long  intervalDuration,
Serializable  info
) 
 

get a Timer from the list

Definition at line 152 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JTimer.equals().

Referenced by org.objectweb.jonas_ejb.container.JTimerHandle.getTimer().

Here is the call graph for this function:

Collection org.objectweb.jonas_ejb.container.JTimerService.getTimers (   )  throws IllegalStateException, EJBException
 

Get all the active timers associated with this bean.

Returns:
A collection of javax.ejb.Timer objects.
Exceptions:
IllegalStateException the instance is in a state that does not allow access to this method.
EJBException If this method could not complete due to a system-level failure.

Definition at line 286 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntitySwitch.getPrimaryKey().

Here is the call graph for this function:

TransactionManager org.objectweb.jonas_ejb.container.JTimerService.getTransactionManager (   ) 
 

Returns:
the Transaction Manager

Definition at line 95 of file JTimerService.java.

Referenced by org.objectweb.jonas_ejb.container.JTimer.cancel(), and org.objectweb.jonas_ejb.container.JTimer.startTimer().

void org.objectweb.jonas_ejb.container.JTimerService.notify (  Timer  timer  ) 
 

Notify the timer to the listener

Parameters:
timer The Timer object that will be notified

Definition at line 103 of file JTimerService.java.

References org.objectweb.jonas_ejb.container.JEntitySwitch.notifyTimeout().

Referenced by org.objectweb.jonas_ejb.container.JTimer.timeoutExpired().

Here is the call graph for this function:

void org.objectweb.jonas_ejb.container.JTimerService.remove (  Timer  timer  ) 
 

Remove the Timer

Parameters:
timer The Timer object that will be removed

Definition at line 124 of file JTimerService.java.

Referenced by org.objectweb.jonas_ejb.container.JTimer.timeoutExpired().

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:10:54 2005 for JOnAS by  doxygen 1.3.9.1