FileDocCategorySizeDatePackage
TimerService.javaAPI DocGlassfish v2 API8213Fri May 04 22:35:54 BST 2007javax.ejb

TimerService

public interface TimerService
The TimerService interface provides enterprise bean components with access to the container-provided Timer Service. The EJB Timer Service allows entity beans, stateless session beans, and message-driven beans to be registered for timer callback events at a specified time, after a specified elapsed time, or after a specified interval.

Fields Summary
Constructors Summary
Methods Summary
public TimercreateTimer(long duration, java.io.Serializable info)
Create a single-action timer that expires after a specified duration.

param
duration The number of milliseconds that must elapse before the timer expires.
param
info Application information to be delivered along with the timer expiration notification. This can be null.
return
The newly created Timer.
exception
java.lang.IllegalArgumentException If duration is negative
exception
java.lang.IllegalStateException If this method is invoked while the instance is in a state that does not allow access to this method.
exception
javax.ejb.EJBException If this method fails due to a system-level failure.

public TimercreateTimer(long initialDuration, long intervalDuration, java.io.Serializable info)
Create an interval timer whose first expiration occurs after a specified duration, and whose subsequent expirations occur after a specified interval.

param
initialDuration The number of milliseconds that must elapse before the first timer expiration notification.
param
intervalDuration The number of milliseconds that must elapse between timer expiration notifications. Expiration notifications are scheduled relative to the time of the first expiration. If expiration is delayed(e.g. due to the interleaving of other method calls on the bean) two or more expiration notifications may occur in close succession to "catch up".
param
info Application information to be delivered along with the timer expiration. This can be null.
return
The newly created Timer.
exception
java.lang.IllegalArgumentException If initialDuration is negative, or intervalDuration is negative.
exception
java.lang.IllegalStateException If this method is invoked while the instance is in a state that does not allow access to this method.
exception
javax.ejb.EJBException If this method could not complete due to a system-level failure.

public TimercreateTimer(java.util.Date expiration, java.io.Serializable info)
Create a single-action timer that expires at a given point in time.

param
expiration The point in time at which the timer must expire.
param
info Application information to be delivered along with the timer expiration notification. This can be null.
return
The newly created Timer.
exception
java.lang.IllegalArgumentException If expiration is null, or expiration.getTime() is negative.
exception
java.lang.IllegalStateException If this method is invoked while the instance is in a state that does not allow access to this method.
exception
javax.ejb.EJBException If this method could not complete due to a system-level failure.

public TimercreateTimer(java.util.Date initialExpiration, long intervalDuration, java.io.Serializable info)
Create an interval timer whose first expiration occurs at a given point in time and whose subsequent expirations occur after a specified interval.

param
initialExpiration The point in time at which the first timer expiration must occur.
param
intervalDuration The number of milliseconds that must elapse between timer expiration notifications. Expiration notifications are scheduled relative to the time of the first expiration. If expiration is delayed(e.g. due to the interleaving of other method calls on the bean) two or more expiration notifications may occur in close succession to "catch up".
param
info Application information to be delivered along with the timer expiration. This can be null.
return
The newly created Timer.
exception
java.lang.IllegalArgumentException If initialExpiration is null, or initialExpiration.getTime() is negative, or intervalDuration is negative.
exception
java.lang.IllegalStateException If this method is invoked while the instance is in a state that does not allow access to this method.
exception
javax.ejb.EJBException If this method could not complete due to a system-level failure.

public java.util.CollectiongetTimers()
Get all the active timers associated with this bean.

return
A collection of javax.ejb.Timer objects.
exception
java.lang.IllegalStateException If this method is invoked while the instance is in a state that does not allow access to this method.
exception
javax.ejb.EJBException If this method could not complete due to a system-level failure.