|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
Timer |
createTimer(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. |
Timer |
createTimer(java.util.Date initialExpiration,
long intervalDuration,
TimerConfig timerConfig)
Create an interval timer whose first expiration occurs at a given point in time and whose subsequent expirations occur after a specified interval. |
Timer |
createTimer(java.util.Date expiration,
java.io.Serializable info)
Create a single-action timer that expires at a given point in time. |
Timer |
createTimer(java.util.Date expiration,
TimerConfig timerConfig)
Create a single-action timer that expires at a given point in time. |
Timer |
createTimer(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. |
Timer |
createTimer(long initialDuration,
long intervalDuration,
TimerConfig timerConfig)
Create an interval timer whose first expiration occurs after a specified duration, and whose subsequent expirations occur after a specified interval. |
Timer |
createTimer(long duration,
java.io.Serializable info)
Create a single-action timer that expires after a specified duration. |
Timer |
createTimer(long duration,
TimerConfig timerConfig)
Create a single-action timer that expires after a specified duration. |
Timer |
createTimer(ScheduleExpression schedule,
java.io.Serializable info)
Create a calendar-based timer based on the input schedule expression. |
Timer |
createTimer(ScheduleExpression schedule,
TimerConfig timerConfig)
Create a calendar-based timer based on the input schedule expression. |
java.util.Collection |
getTimers()
Get all the active timers associated with this bean. |
Method Detail |
---|
Timer createTimer(long duration, java.io.Serializable info) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
duration
- The number of milliseconds that must elapse before the timer expires.info
- Application information to be delivered along with the timer expiration
notification. This can be null.
java.lang.IllegalArgumentException
- If duration is negative
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(long duration, TimerConfig timerConfig) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
duration
- The number of milliseconds that must elapse before the timer expires.timerConfig
- Timer configuration.
java.lang.IllegalArgumentException
- If duration is negative
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(long initialDuration, long intervalDuration, java.io.Serializable info) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
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. 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".info
- Application information to be delivered along with the timer expiration
notification. This can be null.
java.lang.IllegalArgumentException
- If initialDuration is negative, or intervalDuration
is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
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. 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".timerConfig
- Timer configuration.
java.lang.IllegalArgumentException
- If initialDuration is negative, or intervalDuration
is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(java.util.Date expiration, java.io.Serializable info) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
expiration
- The point in time at which the timer must expire.info
- Application information to be delivered along with the timer expiration
notification. This can be null.
java.lang.IllegalArgumentException
- If expiration is null, or expiration.getTime() is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(java.util.Date expiration, TimerConfig timerConfig) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
expiration
- The point in time at which the timer must expire.timerConfig
- Timer configuration.
java.lang.IllegalArgumentException
- If expiration is null, or expiration.getTime() is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(java.util.Date initialExpiration, long intervalDuration, java.io.Serializable info) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
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. 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".info
- Application information to be delivered along with the timer expiration
notification. This can be null.
java.lang.IllegalArgumentException
- If initialExpiration is null, or initialExpiration.getTime()
is negative, or intervalDuration is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(java.util.Date initialExpiration, long intervalDuration, TimerConfig timerConfig) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
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. 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".timerConfig
- Timer configuration.
java.lang.IllegalArgumentException
- If initialExpiration is null, or initialExpiration.getTime()
is negative, or intervalDuration is negative.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(ScheduleExpression schedule, java.io.Serializable info) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
schedule
- A schedule expression describing the timeouts for this timer.info
- Application information to be delivered along with the timer
expiration. This can be null.
java.lang.IllegalArgumentException
- If Schedule represents an invalid schedule
expression.
java.lang.IllegalStateException
- If this method is invoked while 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.Timer createTimer(ScheduleExpression schedule, TimerConfig timerConfig) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException, EJBException
schedule
- A schedule expression describing the timeouts for this timer.timerConfig
- Timer configuration.
java.lang.IllegalArgumentException
- If Schedule represents an invalid schedule
expression.
java.lang.IllegalStateException
- If this method is invoked while 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.java.util.Collection getTimers() throws java.lang.IllegalStateException, EJBException
java.lang.IllegalStateException
- If this method is invoked while 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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |