| java.lang.Object
 org.objectweb.jonas_ejb.container.JTimer
| JTimer | | public class JTimer implements Timer,TimerEventListener,Synchronization(Code) | | JOnAS Implementation of the Timer interface (from EJB 2.1) This is a basic
implementation based on jonas_timer. A later (and better ?) implementation
could be based on Quartz.
author:
Philippe Durieux |
| Method Summary | |
| public void | afterCompletion(int status)
The afterCompletion method is called by the transaction manager after the
transaction is committed or rolled back. | | public void | beforeCompletion()
| | public void | cancel()
Cause the timer and all its associated expiration notifications to be
cancelled. | | public boolean | equals(Object obj)
Indicates whether some other object is "equal to" this one.
Parameters:
obj - - the reference object with which to compare. | | public TimerHandle | getHandle()
Get a serializable handle to the timer. | | public Serializable | getInfo()
Get the information associated with the timer at the time of creation. | | public long | getInitialDuration()
| | public Date | getNextTimeout()
Get the point in time at which the next timer expiration is scheduled to
occur. | | public long | getPeriod()
the period in millisec. | | public long | getStartTime()
| | public long | getTimeRemaining()
Get the number of milliseconds that will elapse before the next scheduled
timer expiration. | | public JTimerService | getTimerService()
| | public int | hashCode()
Returns a hash code value for the object. | | public boolean | isCancelled()
| | public boolean | sameas(Object obj)
This is used to retrieve a Timer from its Handle only. | | public void | setFile(File file)
Set the file associated with this timer. | | public void | startTimer()
| | public void | stopTimer()
Stop a timer. | | public void | timeoutExpired(Object arg)
The timer has just expired. | | public String | toString()
|
| afterCompletion | | public void afterCompletion(int status)(Code) | | The afterCompletion method is called by the transaction manager after the
transaction is committed or rolled back. This method executes without a
transaction context.
Parameters:
status - The status of the transaction completion. |
| beforeCompletion | | public void beforeCompletion()(Code) | | |
| cancel | | public void cancel() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Cause the timer and all its associated expiration notifications to be
cancelled.
throws:
IllegalStateException - the instance is in a state that does notallow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| equals | | public boolean equals(Object obj)(Code) | | Indicates whether some other object is "equal to" this one.
Parameters:
obj - - the reference object with which to compare. true if this object is the same as the obj argument; falseotherwise. |
| getHandle | | public TimerHandle getHandle() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get a serializable handle to the timer. This handle can be used at a
later time to re-obtain the timer reference.
a serializable handle to the timer.
throws:
IllegalStateException - the instance is in a state that does notallow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| getInfo | | public Serializable getInfo() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the information associated with the timer at the time of creation.
The Serializable object that was passed in at timer creation, ornull if the info argument passed in at timer creation was null.
throws:
IllegalStateException - the instance is in a state that does notallow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| getInitialDuration | | public long getInitialDuration()(Code) | | the initial duration in millisec. |
| getNextTimeout | | public Date getNextTimeout() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the point in time at which the next timer expiration is scheduled to
occur.
the point in time at which the next timer expiration is scheduledto occur.
throws:
IllegalStateException - the instance is in a state that does notallow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| getPeriod | | public long getPeriod()(Code) | | the period in millisec. (periodic timers only) |
| getStartTime | | public long getStartTime()(Code) | | the start time in millisec. |
| getTimeRemaining | | public long getTimeRemaining() throws IllegalStateException, NoSuchObjectLocalException, EJBException(Code) | | Get the number of milliseconds that will elapse before the next scheduled
timer expiration.
the number of milliseconds that will elapse before the nextscheduled timer expiration.
throws:
IllegalStateException - the instance is in a state that does notallow access to this method.
throws:
NoSuchObjectLocalException - If invoked on a timer that has expiredor has been cancelled.
throws:
EJBException - If this method could not complete due to asystem-level failure. |
| getTimerService | | public JTimerService getTimerService()(Code) | | the Jonas Timer Service that manages this Timer |
| hashCode | | public int hashCode()(Code) | | Returns a hash code value for the object.
a hash code value for this object. |
| isCancelled | | public boolean isCancelled()(Code) | | true if timer has been cancelled |
| sameas | | public boolean sameas(Object obj)(Code) | | This is used to retrieve a Timer from its Handle only.
|
| setFile | | public void setFile(File file)(Code) | | Set the file associated with this timer.
|
| startTimer | | public void startTimer()(Code) | | start the Timer
|
| stopTimer | | public void stopTimer()(Code) | | Stop a timer. Used internally.
|
| timeoutExpired | | public void timeoutExpired(Object arg)(Code) | | The timer has just expired.
|
| toString | | public String toString()(Code) | | Give a String representation of the Timer
|
|
|