| java.lang.Object
 javax.management.NotificationBroadcasterSupport
javax.management.timer.Timer
| Timer | | public class Timer extends NotificationBroadcasterSupport implements TimerMBean,MBeanRegistration(Code) | | Provides the implementation of the timer MBean.
The timer MBean sends out an alarm at a specified time
that wakes up all the listeners registered to receive timer notifications.
This class manages a list of dated timer notifications.
A method allows users to add/remove as many notifications as required.
When a timer notification is emitted by the timer and becomes obsolete,
it is automatically removed from the list of timer notifications.
Additional timer notifications can be added into regularly repeating notifications.
Note:
- When sending timer notifications, the timer updates the notification sequence number
irrespective of the notification type.
- The timer service relies on the system date of the host where the
Timer class is loaded.
Listeners may receive untimely notifications
if their host has a different system date.
To avoid such problems, synchronize the system date of all host machines where timing is needed.
- The default behavior for periodic notifications is fixed-delay execution, as
specified in
java.util.Timer . In order to use fixed-rate execution, use the
overloaded
Timer.addNotification(String,String,Object,Date,long,long,boolean) method.
- Notification listeners are potentially all executed in the same
thread. Therefore, they should execute rapidly to avoid holding up
other listeners or perturbing the regularity of fixed-delay
executions. See
NotificationBroadcasterSupport .
since:
1.5 |
| Field Summary | |
| final public static long | ONE_DAY
Number of milliseconds in one day. | | final public static long | ONE_HOUR
Number of milliseconds in one hour. | | final public static long | ONE_MINUTE
Number of milliseconds in one minute. | | final public static long | ONE_SECOND
Number of milliseconds in one second. | | final public static long | ONE_WEEK
Number of milliseconds in one week. |
| Constructor Summary | |
| public | Timer()
Default constructor. |
| Method Summary | |
| public synchronized Integer | addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate)
Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date,
period and number of occurrences.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date. | | public synchronized Integer | addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences)
Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date,
period and number of occurrences.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date. | | public synchronized Integer | addNotification(String type, String message, Object userData, Date date, long period)
Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date
and period and a null number of occurrences.
The timer notification will repeat continuously using the timer period using a fixed-delay
execution scheme, as specified in
java.util.Timer . | | public synchronized Integer | addNotification(String type, String message, Object userData, Date date)
Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date
and a null period and number of occurrences.
The timer notification will be handled once at the specified date.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date and the
notification is delivered immediately.
Parameters:
type - The timer notification type.
Parameters:
message - The timer notification detailed message.
Parameters:
userData - The timer notification user data object.
Parameters:
date - The date when the notification occurs. | | public synchronized Vector<Integer> | getAllNotificationIDs()
Gets all timer notification identifiers registered into the list of notifications. | | public Date | getDate(Integer id)
Gets a copy of the date associated to a timer notification.
Parameters:
id - The timer notification identifier. | | public Boolean | getFixedRate(Integer id)
Gets a copy of the flag indicating whether a periodic notification is
executed at fixed-delay or at fixed-rate.
Parameters:
id - The timer notification identifier. | | public int | getNbNotifications()
Gets the number of timer notifications registered into the list of notifications. | | public Long | getNbOccurences(Integer id)
Gets a copy of the remaining number of occurrences associated to a timer notification.
Parameters:
id - The timer notification identifier. | | public synchronized Vector<Integer> | getNotificationIDs(String type)
Gets all the identifiers of timer notifications corresponding to the specified type.
Parameters:
type - The timer notification type. | | public synchronized MBeanNotificationInfo[] | getNotificationInfo()
| | public String | getNotificationMessage(Integer id)
Gets the timer notification detailed message corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. | | public String | getNotificationType(Integer id)
Gets the timer notification type corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. | | public Object | getNotificationUserData(Integer id)
Gets the timer notification user data object corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. | | public Long | getPeriod(Integer id)
Gets a copy of the period (in milliseconds) associated to a timer notification.
Parameters:
id - The timer notification identifier. | | public boolean | getSendPastNotifications()
Gets the flag indicating whether or not the timer sends past notifications. | | public boolean | isActive()
Tests whether the timer MBean is active. | | public boolean | isEmpty()
Tests whether the list of timer notifications is empty. | | void | notifyAlarmClock(TimerAlarmClockNotification notification)
This method is called by the timer each time
the TimerAlarmClock has exceeded its timeout. | | public void | postDeregister()
Allows the timer MBean to perform any operations needed after having been
unregistered by the MBean server. | | public void | postRegister(Boolean registrationDone)
Allows the timer MBean to perform any operations needed after having been
registered in the MBean server or after the registration has failed. | | public void | preDeregister()
Allows the timer MBean to perform any operations it needs before being unregistered
by the MBean server. | | public ObjectName | preRegister(MBeanServer server, ObjectName name)
Allows the timer MBean to perform any operations it needs before being registered
in the MBean server.
Not used in this context.
Parameters:
server - The MBean server in which the timer MBean will be registered.
Parameters:
name - The object name of the timer MBean. | | public synchronized void | removeAllNotifications()
Removes all the timer notifications from the list of notifications
and resets the counter used to update the timer notification identifiers. | | public synchronized void | removeNotification(Integer id)
Removes the timer notification corresponding to the specified identifier from the list of notifications. | | public synchronized void | removeNotifications(String type)
Removes all the timer notifications corresponding to the specified type from the list of notifications. | | void | sendNotification(Date timeStamp, TimerNotification notification)
This method is used by the timer MBean to update and send a timer
notification to all the listeners registered for this kind of notification. | | public void | setSendPastNotifications(boolean value)
Sets the flag indicating whether the timer sends past notifications or not. | | public synchronized void | start()
Starts the timer. | | public synchronized void | stop()
Stops the timer. |
| ONE_DAY | | final public static long ONE_DAY(Code) | | Number of milliseconds in one day.
Useful constant for the addNotification method.
|
| ONE_HOUR | | final public static long ONE_HOUR(Code) | | Number of milliseconds in one hour.
Useful constant for the addNotification method.
|
| ONE_MINUTE | | final public static long ONE_MINUTE(Code) | | Number of milliseconds in one minute.
Useful constant for the addNotification method.
|
| ONE_SECOND | | final public static long ONE_SECOND(Code) | | Number of milliseconds in one second.
Useful constant for the addNotification method.
|
| ONE_WEEK | | final public static long ONE_WEEK(Code) | | Number of milliseconds in one week.
Useful constant for the addNotification method.
|
| Timer | | public Timer()(Code) | | Default constructor.
|
| addNotification | | public synchronized Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws java.lang.IllegalArgumentException(Code) | | Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date,
period and number of occurrences.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date.
For once-off notifications, the notification is delivered immediately.
For periodic notifications, the first notification is delivered immediately and the
subsequent ones are spaced as specified by the period parameter.
Note that once the timer notification has been added into the list of notifications,
its associated date, period and number of occurrences cannot be updated.
In the case of a periodic notification, the value of parameter fixedRate is used to
specify the execution scheme, as specified in
java.util.Timer .
Parameters:
type - The timer notification type.
Parameters:
message - The timer notification detailed message.
Parameters:
userData - The timer notification user data object.
Parameters:
date - The date when the notification occurs.
Parameters:
period - The period of the timer notification (in milliseconds).
Parameters:
nbOccurences - The total number the timer notification will be emitted.
Parameters:
fixedRate - If true and if the notification is periodic, the notificationis scheduled with a fixed-rate execution scheme. Iffalse and if the notification is periodic, the notificationis scheduled with a fixed-delay execution scheme. Ignored if thenotification is not periodic. The identifier of the new created timer notification.
exception:
java.lang.IllegalArgumentException - The date is null orthe period or the number of occurrences is negative.
See Also: Timer.addNotification(String,String,Object,Date,long,long) |
| addNotification | | public synchronized Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) throws java.lang.IllegalArgumentException(Code) | | Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date,
period and number of occurrences.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date.
For once-off notifications, the notification is delivered immediately.
For periodic notifications, the first notification is delivered immediately and the
subsequent ones are spaced as specified by the period parameter.
Note that once the timer notification has been added into the list of notifications,
its associated date, period and number of occurrences cannot be updated.
In the case of a periodic notification, uses a fixed-delay execution scheme, as specified in
java.util.Timer . In order to use a fixed-rate execution scheme, use
Timer.addNotification(String,String,Object,Date,long,long,boolean) instead.
Parameters:
type - The timer notification type.
Parameters:
message - The timer notification detailed message.
Parameters:
userData - The timer notification user data object.
Parameters:
date - The date when the notification occurs.
Parameters:
period - The period of the timer notification (in milliseconds).
Parameters:
nbOccurences - The total number the timer notification will be emitted. The identifier of the new created timer notification.
exception:
java.lang.IllegalArgumentException - The date is null orthe period or the number of occurrences is negative.
See Also: Timer.addNotification(String,String,Object,Date,long,long,boolean) |
| addNotification | | public synchronized Integer addNotification(String type, String message, Object userData, Date date, long period) throws java.lang.IllegalArgumentException(Code) | | Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date
and period and a null number of occurrences.
The timer notification will repeat continuously using the timer period using a fixed-delay
execution scheme, as specified in
java.util.Timer . In order to use a fixed-rate
execution scheme, use
Timer.addNotification(String,String,Object,Date,long,long,boolean) instead.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date. The
first notification is delivered immediately and the subsequent ones are
spaced as specified by the period parameter.
Parameters:
type - The timer notification type.
Parameters:
message - The timer notification detailed message.
Parameters:
userData - The timer notification user data object.
Parameters:
date - The date when the notification occurs.
Parameters:
period - The period of the timer notification (in milliseconds). The identifier of the new created timer notification.
exception:
java.lang.IllegalArgumentException - The date is null orthe period is negative. |
| addNotification | | public synchronized Integer addNotification(String type, String message, Object userData, Date date) throws java.lang.IllegalArgumentException(Code) | | Creates a new timer notification with the specified type, message
and userData and inserts it into the list of notifications with a given date
and a null period and number of occurrences.
The timer notification will be handled once at the specified date.
If the timer notification to be inserted has a date that is before the current date,
the method behaves as if the specified date were the current date and the
notification is delivered immediately.
Parameters:
type - The timer notification type.
Parameters:
message - The timer notification detailed message.
Parameters:
userData - The timer notification user data object.
Parameters:
date - The date when the notification occurs. The identifier of the new created timer notification.
exception:
java.lang.IllegalArgumentException - The date is null . |
| getAllNotificationIDs | | public synchronized Vector<Integer> getAllNotificationIDs()(Code) | | Gets all timer notification identifiers registered into the list of notifications.
A vector of Integer objects containing all the timer notification identifiers.
The vector is empty if there is no timer notification registered for this timer MBean. |
| getDate | | public Date getDate(Integer id)(Code) | | Gets a copy of the date associated to a timer notification.
Parameters:
id - The timer notification identifier. A copy of the date or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getFixedRate | | public Boolean getFixedRate(Integer id)(Code) | | Gets a copy of the flag indicating whether a periodic notification is
executed at fixed-delay or at fixed-rate.
Parameters:
id - The timer notification identifier. A copy of the flag indicating whether a periodic notification isexecuted at fixed-delay or at fixed-rate. |
| getNbNotifications | | public int getNbNotifications()(Code) | | Gets the number of timer notifications registered into the list of notifications.
The number of timer notifications. |
| getNbOccurences | | public Long getNbOccurences(Integer id)(Code) | | Gets a copy of the remaining number of occurrences associated to a timer notification.
Parameters:
id - The timer notification identifier. A copy of the remaining number of occurrences or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getNotificationIDs | | public synchronized Vector<Integer> getNotificationIDs(String type)(Code) | | Gets all the identifiers of timer notifications corresponding to the specified type.
Parameters:
type - The timer notification type. A vector of Integer objects containing all the identifiers oftimer notifications with the specified type.
The vector is empty if there is no timer notifications registered for this timer MBeanwith the specified type. |
| getNotificationMessage | | public String getNotificationMessage(Integer id)(Code) | | Gets the timer notification detailed message corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. The timer notification detailed message or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getNotificationType | | public String getNotificationType(Integer id)(Code) | | Gets the timer notification type corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. The timer notification type or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getNotificationUserData | | public Object getNotificationUserData(Integer id)(Code) | | Gets the timer notification user data object corresponding to the specified identifier.
Parameters:
id - The timer notification identifier. The timer notification user data object or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getPeriod | | public Long getPeriod(Integer id)(Code) | | Gets a copy of the period (in milliseconds) associated to a timer notification.
Parameters:
id - The timer notification identifier. A copy of the period or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getSendPastNotifications | | public boolean getSendPastNotifications()(Code) | | Gets the flag indicating whether or not the timer sends past notifications.
The default value of the past notifications sending on/off flag is false.
The past notifications sending on/off flag value.
See Also: Timer.setSendPastNotifications |
| isActive | | public boolean isActive()(Code) | | Tests whether the timer MBean is active.
A timer MBean is marked active when the
Timer.start start method is called.
It becomes inactive when the
Timer.stop stop method is called.
The default value of the active on/off flag is false.
true if the timer MBean is active, false otherwise. |
| isEmpty | | public boolean isEmpty()(Code) | | Tests whether the list of timer notifications is empty.
true if the list of timer notifications is empty, false otherwise. |
| notifyAlarmClock | | void notifyAlarmClock(TimerAlarmClockNotification notification)(Code) | | This method is called by the timer each time
the TimerAlarmClock has exceeded its timeout.
Parameters:
notification - The TimerAlarmClock notification. |
| postDeregister | | public void postDeregister()(Code) | | Allows the timer MBean to perform any operations needed after having been
unregistered by the MBean server.
Not used in this context.
|
| postRegister | | public void postRegister(Boolean registrationDone)(Code) | | Allows the timer MBean to perform any operations needed after having been
registered in the MBean server or after the registration has failed.
Not used in this context.
|
| preDeregister | | public void preDeregister() throws java.lang.Exception(Code) | | Allows the timer MBean to perform any operations it needs before being unregistered
by the MBean server.
Stops the timer.
exception:
java.lang.Exception - |
| preRegister | | public ObjectName preRegister(MBeanServer server, ObjectName name) throws java.lang.Exception(Code) | | Allows the timer MBean to perform any operations it needs before being registered
in the MBean server.
Not used in this context.
Parameters:
server - The MBean server in which the timer MBean will be registered.
Parameters:
name - The object name of the timer MBean. The name of the timer MBean registered.
exception:
java.lang.Exception - |
| removeAllNotifications | | public synchronized void removeAllNotifications()(Code) | | Removes all the timer notifications from the list of notifications
and resets the counter used to update the timer notification identifiers.
|
| removeNotification | | public synchronized void removeNotification(Integer id) throws InstanceNotFoundException(Code) | | Removes the timer notification corresponding to the specified identifier from the list of notifications.
Parameters:
id - The timer notification identifier.
exception:
InstanceNotFoundException - The specified identifier does not correspond to any timer notificationin the list of notifications of this timer MBean. |
| removeNotifications | | public synchronized void removeNotifications(String type) throws InstanceNotFoundException(Code) | | Removes all the timer notifications corresponding to the specified type from the list of notifications.
Parameters:
type - The timer notification type.
exception:
InstanceNotFoundException - The specified type does not correspond to any timer notificationin the list of notifications of this timer MBean. |
| sendNotification | | void sendNotification(Date timeStamp, TimerNotification notification)(Code) | | This method is used by the timer MBean to update and send a timer
notification to all the listeners registered for this kind of notification.
Parameters:
timeStamp - The notification emission date.
Parameters:
notification - The timer notification to send. |
| setSendPastNotifications | | public void setSendPastNotifications(boolean value)(Code) | | Sets the flag indicating whether the timer sends past notifications or not.
The default value of the past notifications sending on/off flag is false.
Parameters:
value - The past notifications sending on/off flag value.
See Also: Timer.getSendPastNotifications |
| start | | public synchronized void start()(Code) | | Starts the timer.
If there is one or more timer notifications before the time in the list of notifications, the notification
is sent according to the sendPastNotifications flag and then, updated
according to its period and remaining number of occurrences.
If the timer notification date remains earlier than the current date, this notification is just removed
from the list of notifications.
|
| stop | | public synchronized void stop()(Code) | | Stops the timer.
|
|
|