|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Alarm
An object implementing this interface is returned when an alarm is created. It allows the alarm to be manipulated and allows the alarm to be reset to fire at another time as well as allows the alarm context object to be retrieved.
Alarms are transient and not transactional and run inside the JVM which created them. If a cluster wide scheduled event is required or it needs to be persistent,transactional or recoverable then the Scheduler should be used instead.
AlarmManager
,
AlarmListener
,
Scheduler
Method Summary | |
---|---|
void |
cancel()
This cancels the alarm that is currently pending. |
AlarmListener |
getAlarmListener()
This returns the application supplied AlarmListener associated with this alarm. |
java.lang.Object |
getContext()
This returns the context object associated with the alarm when it was created. |
void |
reset(int milliSeconds)
This cancels the current alarm and reschedules it to fire at a later time. |
Method Detail |
---|
java.lang.Object getContext()
java.lang.IllegalStateException
- If the owner AsynchScope is destroyed.void reset(int milliSeconds)
milliSeconds
- The number of milliseconds from now that the
alarm will fire in.
java.lang.IllegalStateException
- If the owner AsynchScope is destroyed.void cancel()
Once cancel is called then an application must not use the alarm instance again as it will be reused by a subsequent alarm.
If the owning AsynchScope was destroyed then this method does not throw IllegalState as the alarm is already cancelled.
AlarmListener getAlarmListener()
java.lang.IllegalStateException
- If the owner AsynchScope is destroyed.
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |