| javax.management.timer.TimerMBean
All known Subclasses: javax.management.timer.Timer,
| TimerMBean | | public interface TimerMBean (Code) | | Exposes the management interface of the timer MBean.
author:
Young Yang |
| 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. | | public 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 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. | | public 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 occurences.
The timer notification will repeat continuously using the timer period using a fixed-delay
execution scheme, as specified in
java.util.Timer . | | public 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 occurences.
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 Vector | 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 peridic 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 occurences associated to a timer notification.
Parameters:
id - The timer notification identifier. | | public Vector | getNotificationIDs(String type)
Gets all the identifiers of timer notifications corresponding to the specified type.
Parameters:
type - The timer notification type. | | 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. | | public void | removeAllNotifications()
Removes all the timer notifications from the list of notifications
and resets the counter used to update the timer notification identifiers. | | public void | removeNotification(Integer id)
Removes the timer notification corresponding to the specified identifier from the list of notifications. | | public void | removeNotifications(String type)
Removes all the timer notifications corresponding to the specified type from the list of notifications. | | public void | setSendPastNotifications(boolean value)
Sets the flag indicating whether the timer sends past notifications or not. | | 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 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 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
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 period or the number of occurences is negative
See Also: TimerMBean.addNotification(String,String,Object,Date,long,long) |
| addNotification | | public 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 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, uses a fixed-delay execution scheme, as specified in
java.util.Timer . In order to use a fixed-rate execution scheme, use
TimerMBean.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 period or the number of occurences is negative
See Also: TimerMBean.addNotification(String,String,Object,Date,long,long,boolean) |
| addNotification | | public 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 occurences.
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
TimerMBean.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 period is negative orthe date notification is before the current date. |
| addNotification | | public 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 occurences.
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 notification is before the current date. |
| getAllNotificationIDs | | public Vector 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 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 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 occurences associated to a timer notification.
Parameters:
id - The timer notification identifier. A copy of the remaining number of occurences or null if the identifier is not mapped to anytimer notification registered for this timer MBean. |
| getNotificationIDs | | public Vector 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 past notifications sending on/off flag value.
See Also: TimerMBean.setSendPastNotifications |
| isActive | | public boolean isActive()(Code) | | Tests whether the timer MBean is active.
A timer MBean is marked active when the
TimerMBean.start doStart method is called.
It becomes inactive when the
TimerMBean.stop doStop method is called.
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. |
| removeAllNotifications | | public 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 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 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. |
| setSendPastNotifications | | public void setSendPastNotifications(boolean value)(Code) | | Sets the flag indicating whether the timer sends past notifications or not.
Parameters:
value - The past notifications sending on/off flag value.
See Also: TimerMBean.getSendPastNotifications |
| start | | public 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 occurences.
If the timer notification date remains earlier than the current date, this notification is just removed
from the list of notifications.
|
| stop | | public void stop()(Code) | | Stops the timer.
|
|
|