|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.management.NotificationBroadcasterSupport | +--javax.management.timer.Timer
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:
addNotification
method is called
are ignored, irrespective of the sendPastNotifications
flag.
Timer
class is loaded.
Callers may be unable to add notifications to the timer, and listeners may recieve 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.
Field Summary | |
static long |
ONE_DAY
Number of milliseconds in one day. |
static long |
ONE_HOUR
Number of milliseconds in one hour. |
static long |
ONE_MINUTE
Number of milliseconds in one minute. |
static long |
ONE_SECOND
Number of milliseconds in one second. |
static long |
ONE_WEEK
Number of milliseconds in one week. |
Constructor Summary | |
Timer()
Default constructor. |
Method Summary | |
java.lang.Integer |
addNotification(java.lang.String type,
java.lang.String message,
java.lang.Object userData,
java.util.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. |
java.lang.Integer |
addNotification(java.lang.String type,
java.lang.String message,
java.lang.Object userData,
java.util.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. |
java.lang.Integer |
addNotification(java.lang.String type,
java.lang.String message,
java.lang.Object userData,
java.util.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. |
java.util.Vector |
getAllNotificationIDs()
Gets all timer notification identifiers registered into the list of notifications. |
java.util.Date |
getDate(java.lang.Integer id)
Gets a copy of the date associated to a timer notification. |
int |
getNbNotifications()
Gets the number of timer notifications registered into the list of notifications. |
java.lang.Long |
getNbOccurences(java.lang.Integer id)
Gets a copy of the remaining number of occurences associated to a timer notification. |
java.util.Vector |
getNotificationIDs(java.lang.String type)
Gets all the identifiers of timer notifications corresponding to the specified type. |
java.lang.String |
getNotificationMessage(java.lang.Integer id)
Gets the timer notification detailed message corresponding to the specified identifier. |
java.lang.String |
getNotificationType(java.lang.Integer id)
Gets the timer notification type corresponding to the specified identifier. |
java.lang.Object |
getNotificationUserData(java.lang.Integer id)
Gets the timer notification user data object corresponding to the specified identifier. |
java.lang.Long |
getPeriod(java.lang.Integer id)
Gets a copy of the period (in milliseconds) associated to a timer notification. |
boolean |
getSendPastNotifications()
Gets the flag indicating whether or not the timer sends past notifications. |
boolean |
isActive()
Tests whether the timer MBean is active. |
boolean |
isEmpty()
Tests whether the list of timer notifications is empty. |
void |
postDeregister()
Allows the timer MBean to perform any operations needed after having been de-registered by the MBean server. |
void |
postRegister(java.lang.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. |
void |
preDeregister()
Allows the timer MBean to perform any operations it needs before being de-registered by the MBean server. |
ObjectName |
preRegister(MBeanServer server,
ObjectName name)
Allows the timer MBean to perform any operations it needs before being registered in the MBean server. |
void |
removeAllNotifications()
Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers. |
void |
removeNotification(java.lang.Integer id)
Removes the timer notification corresponding to the specified identifier from the list of notifications. |
void |
removeNotifications(java.lang.String type)
Removes all the timer notifications corresponding to the specified type from the list of notifications. |
void |
setSendPastNotifications(boolean value)
Sets the flag indicating whether the timer sends past notifications or not. |
void |
start()
Starts the timer. |
void |
stop()
Stops the timer. |
Methods inherited from class javax.management.NotificationBroadcasterSupport |
addNotificationListener,
getNotificationInfo,
removeNotificationListener,
sendNotification |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final long ONE_SECOND
addNotification
method.public static final long ONE_MINUTE
addNotification
method.public static final long ONE_HOUR
addNotification
method.public static final long ONE_DAY
addNotification
method.public static final long ONE_WEEK
addNotification
method.Constructor Detail |
public Timer()
Method Detail |
public ObjectName preRegister(MBeanServer server, ObjectName name) throws java.lang.Exception
Not used in this context.
server
- The MBean server in which the timer MBean will be registered.name
- The object name of the timer MBean.public void postRegister(java.lang.Boolean registrationDone)
Not used in this context.
registrationDone
- Indicates whether or not the MBean has been successfully registered in
the MBean server. The value false means that the registration phase has failed.public void preDeregister() throws java.lang.Exception
Stops the timer.
public void postDeregister()
Not used in this context.
public void start()
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.
public void stop()
public java.lang.Integer addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period, long nbOccurences) throws java.lang.IllegalArgumentException
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 attempts to update the notification using the defined period. If the defined period is null, the method generates an exception.
If the timer notification has a non null period, the date of the notification is updated by adding the period until the notification date is later than the current date. The timer notification is then inserted into the list of notifications.
If the specified number of occurences is non null, the previous mechanism is employed. The number of times that the period is added is limited by the specified number of occurences. If the notification date remains earlier than the current date, an exception is generated.
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.
type
- The timer notification type.message
- The timer notification detailed message.userData
- The timer notification user data object.date
- The date when the notification occurs.period
- The period of the timer notification (in milliseconds).nbOccurences
- The total number the timer notification will be emitted.public java.lang.Integer addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period) throws java.lang.IllegalArgumentException
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.
type
- The timer notification type.message
- The timer notification detailed message.userData
- The timer notification user data object.date
- The date when the notification occurs.period
- The period of the timer notification (in milliseconds).public java.lang.Integer addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date) throws java.lang.IllegalArgumentException
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.
type
- The timer notification type.message
- The timer notification detailed message.userData
- The timer notification user data object.date
- The date when the notification occurs.public void removeNotification(java.lang.Integer id) throws InstanceNotFoundException
id
- The timer notification identifier.public void removeNotifications(java.lang.String type) throws InstanceNotFoundException
type
- The timer notification type.public void removeAllNotifications()
public int getNbNotifications()
public java.util.Vector getAllNotificationIDs()
Integer
objects containing all the timer notification identifiers.
public java.util.Vector getNotificationIDs(java.lang.String type)
type
- The timer notification type.Integer
objects containing all the identifiers of
timer notifications with the specified type
.
type
.public java.lang.String getNotificationType(java.lang.Integer id)
id
- The timer notification identifier.public java.lang.String getNotificationMessage(java.lang.Integer id)
id
- The timer notification identifier.public java.lang.Object getNotificationUserData(java.lang.Integer id)
id
- The timer notification identifier.public java.util.Date getDate(java.lang.Integer id)
id
- The timer notification identifier.public java.lang.Long getPeriod(java.lang.Integer id)
id
- The timer notification identifier.public java.lang.Long getNbOccurences(java.lang.Integer id)
id
- The timer notification identifier.public boolean getSendPastNotifications()
false
.public void setSendPastNotifications(boolean value)
false
.value
- The past notifications sending on/off flag value.public boolean isActive()
start
method is called.
It becomes inactive when the stop
method is called.
false
.true
if the timer MBean is active, false
otherwise.public boolean isEmpty()
true
if the list of timer notifications is empty, false
otherwise.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |