| javax.management.timer.TimerMBean
All known Subclasses: javax.management.timer.Timer,
| TimerMBean | | public interface TimerMBean (Code) | | The timer service MBean interface.
author:
Adrian Brock
version:
$Revision: 57200 $ |
| Method Summary | |
| public 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 occurences.
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 occurences 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 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 notification is scheduled with a fixed-rate execution scheme. | | public Integer | addNotification(String type, String message, Object userData, Date date, long period, long occurences)
Creates a new timer notification for a specific date/time, with an
optional repeat period and a maximum number of occurences.
If the date and time is before the the current date and time the period
is repeatedly added until a date after the current date and time is
found. | | public Integer | addNotification(String type, String message, Object userData, Date date, long period)
Creates a new timer notification for a specific date/time, with an
optional repeat period.
When the repeat period is not zero, the notification repeats forever.
If the date and time is before the the current date and time the period
is repeatedly added until a date after the current date and time is
found.
Parameters:
type - the notification type.
Parameters:
message - the notification's message string.
Parameters:
userData - the notification's user data.
Parameters:
date - the date/time the notification will occur.
Parameters:
period - the repeat period in milli-seconds. | | public Integer | addNotification(String type, String message, Object userData, Date date)
Creates a new timer notification for a specific date/time.
The notification is performed once.
Parameters:
type - the notification type.
Parameters:
message - the notification's message string.
Parameters:
userData - the notification's user data.
Parameters:
date - the date/time the notification will occur. | | public Vector | getAllNotificationIDs()
Retrieves all timer notifications ids.
a vector of Integers containing the ids. | | public Date | getDate(Integer id)
Retrieves a copy of the notification date for a passed notification id.
Parameters:
id - the notification id. | | public Boolean | getFixedRate(Integer id)
Gets a copy of the flag indicating whether a peridic notification is executed at fixed-delay or at fixed-rate.
Parameters:
id - The timer notification identifier. | | public int | getNbNotifications()
Retrieves the number of registered timer notifications. | | public Long | getNbOccurences(Integer id)
Retrieves a copy of the maximum notification occurences for a passed
notification id.
Parameters:
id - the notification id. | | public Vector | getNotificationIDs(String type)
Retrieves all timer notifications ids of the passed notification type.
Parameters:
type - the notification type. | | public String | getNotificationMessage(Integer id)
Retrieves the notification message for a passed notification id.
Parameters:
id - the notification id. | | public String | getNotificationType(Integer id)
Retrieves the notification type for a passed notification id.
Parameters:
id - the notification id. | | public Object | getNotificationUserData(Integer id)
Retrieves the notification user data for a passed notification id.
Parameters:
id - the notification id. | | public Long | getPeriod(Integer id)
Retrieves a copy of the notification period for a passed notification id.
Parameters:
id - the notification id. | | public boolean | getSendPastNotifications()
Retrieves the flag indicating whether past notifications are sent. | | public boolean | isActive()
Test whether the timer MBean is active. | | public boolean | isEmpty()
Test whether the timer MBean has any registered notifications. | | public void | removeAllNotifications()
Removes all notifications from the timer MBean. | | public void | removeNotification(Integer id)
Removes a notification from the timer MBean with the specified
notification id. | | public void | removeNotifications(String type)
Removes all notifications from the timer MBean of the specified
notification type. | | public void | setSendPastNotifications(boolean value)
Sets the flag indicating whether past notifications are sent.
Parameters:
value - the new value of the flag. | | public void | start()
Starts the timer. | | public void | stop()
Stops the timer. |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws 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 occurences.
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 occurences 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 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 notification is scheduled with a fixed-rate execution scheme. If false and if the notification is periodic, the notification is scheduled with a fixed-delay execution scheme. Ignored if the notification is not periodic. The identifier of the new created timer notification.
throws:
IllegalArgumentException - The period or the number of occurences is negative |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period, long occurences) throws IllegalArgumentException(Code) | | Creates a new timer notification for a specific date/time, with an
optional repeat period and a maximum number of occurences.
If the date and time is before the the current date and time the period
is repeatedly added until a date after the current date and time is
found. If the number of occurences is exceeded before the
current date and time is reached, an IllegalArgumentException is raised.
Parameters:
type - the notification type.
Parameters:
message - the notification's message string.
Parameters:
userData - the notification's user data.
Parameters:
date - the date/time the notification will occur.
Parameters:
period - the repeat period in milli-seconds. Passing zero meansno repeat.
Parameters:
occurences - the maximum number of repeats. When the period is notzero and this parameter is zero, it will repeat indefinitely. the notification id for this notification.
throws:
IllegalArgumentException - when the date is before the currentdate, the period is negative or the number of repeats isnegative. |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period) throws IllegalArgumentException(Code) | | Creates a new timer notification for a specific date/time, with an
optional repeat period.
When the repeat period is not zero, the notification repeats forever.
If the date and time is before the the current date and time the period
is repeatedly added until a date after the current date and time is
found.
Parameters:
type - the notification type.
Parameters:
message - the notification's message string.
Parameters:
userData - the notification's user data.
Parameters:
date - the date/time the notification will occur.
Parameters:
period - the repeat period in milli-seconds. Passing zero meansno repeat. the notification id for this notification.
throws:
IllegalArgumentException - when the date is before the currentdate or the period is negative. |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date) throws IllegalArgumentException(Code) | | Creates a new timer notification for a specific date/time.
The notification is performed once.
Parameters:
type - the notification type.
Parameters:
message - the notification's message string.
Parameters:
userData - the notification's user data.
Parameters:
date - the date/time the notification will occur. the notification id for this notification.
throws:
IllegalArgumentException - when the date is before the currentdate. |
| getAllNotificationIDs | | public Vector getAllNotificationIDs()(Code) | | Retrieves all timer notifications ids.
a vector of Integers containing the ids. The list is emptywhen there are no timer notifications. |
| getDate | | public Date getDate(Integer id)(Code) | | Retrieves a copy of the notification date for a passed notification id.
Parameters:
id - the notification id. a copy of the notification date or null when the notification idis not registered. |
| getFixedRate | | public Boolean getFixedRate(Integer id)(Code) | | Gets a copy of the flag indicating whether a peridic notification is executed at fixed-delay or at fixed-rate.
Parameters:
id - The timer notification identifier. A copy of the flag indicating whether a peridic notification is executed at fixed-delay or at fixed-rate. |
| getNbNotifications | | public int getNbNotifications()(Code) | | Retrieves the number of registered timer notifications.
the number of notifications. |
| getNbOccurences | | public Long getNbOccurences(Integer id)(Code) | | Retrieves a copy of the maximum notification occurences for a passed
notification id.
Parameters:
id - the notification id. a copy of the maximum notification occurences or null when thenotification id is not registered. |
| getNotificationIDs | | public Vector getNotificationIDs(String type)(Code) | | Retrieves all timer notifications ids of the passed notification type.
Parameters:
type - the notification type. a vector of Integers containing the ids. The list is emptywhen there are no timer notifications of the passed type. |
| getNotificationMessage | | public String getNotificationMessage(Integer id)(Code) | | Retrieves the notification message for a passed notification id.
Parameters:
id - the notification id. the notification message or null when the notification id isnot registered. |
| getNotificationType | | public String getNotificationType(Integer id)(Code) | | Retrieves the notification type for a passed notification id.
Parameters:
id - the notification id. the notification type or null when the notification id isnot registered. |
| getNotificationUserData | | public Object getNotificationUserData(Integer id)(Code) | | Retrieves the notification user data for a passed notification id.
Parameters:
id - the notification id. the notification user data or null when the notification id isnot registered. |
| getPeriod | | public Long getPeriod(Integer id)(Code) | | Retrieves a copy of the notification period for a passed notification id.
Parameters:
id - the notification id. a copy of the notification period or null when the notificationid is not registered. |
| getSendPastNotifications | | public boolean getSendPastNotifications()(Code) | | Retrieves the flag indicating whether past notifications are sent.
true when past notifications are sent, false otherwise. |
| isActive | | public boolean isActive()(Code) | | Test whether the timer MBean is active.
true when timer is active, false otherwise. |
| isEmpty | | public boolean isEmpty()(Code) | | Test whether the timer MBean has any registered notifications.
true when timer has no registered notifications, false otherwise. |
| removeAllNotifications | | public void removeAllNotifications()(Code) | | Removes all notifications from the timer MBean.
|
| removeNotifications | | public void removeNotifications(String type) throws InstanceNotFoundException(Code) | | Removes all notifications from the timer MBean of the specified
notification type.
Parameters:
type - the notification type.
throws:
InstanceNotFoundException - when there are no notifications ofthe type passed. |
| setSendPastNotifications | | public void setSendPastNotifications(boolean value)(Code) | | Sets the flag indicating whether past notifications are sent.
Parameters:
value - the new value of the flag. true when past notificationsare sent, false otherwise. |
| start | | public void start()(Code) | | Starts the timer. If there are any notifications before the current time
these notifications are processed. The notification only takes place
when send past notiications is true.
|
| stop | | public void stop()(Code) | | Stops the timer.
|
|
|