|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.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.
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.
Timer. In order to use fixed-rate execution, use the
overloaded addNotification(String, String, Object, Date, long, long, boolean) method.
NotificationBroadcasterSupport.
| 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 occurrences.
|
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 occurrences.
|
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 occurrences.
|
java.lang.Integer |
addNotification(java.lang.String type,
java.lang.String message,
java.lang.Object userData,
java.util.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.
|
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. |
java.lang.Boolean |
getFixedRate(java.lang.Integer id)
Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate. |
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 occurrences 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. |
MBeanNotificationInfo[] |
getNotificationInfo()
Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification 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 unregistered 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 unregistered 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, handleNotification, removeNotificationListener, 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.
preRegister in interface MBeanRegistrationserver - The MBean server in which the timer MBean will be registered.name - The object name of the timer MBean.
java.lang.Exceptionpublic void postRegister(java.lang.Boolean registrationDone)
Not used in this context.
postRegister in interface MBeanRegistrationregistrationDone - 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.
preDeregister in interface MBeanRegistrationjava.lang.Exceptionpublic void postDeregister()
Not used in this context.
postDeregister in interface MBeanRegistrationpublic MBeanNotificationInfo[] getNotificationInfo()
NotificationBroadcasterReturns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.
It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.
getNotificationInfo in interface NotificationBroadcastergetNotificationInfo in class NotificationBroadcasterSupportpublic 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 occurrences.
If the timer notification date remains earlier than the current date, this notification is just removed
from the list of notifications.
start in interface TimerMBeanpublic void stop()
stop in interface TimerMBean
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,
boolean fixedRate)
throws java.lang.IllegalArgumentException
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 Timer.
addNotification in interface TimerMBeantype - 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.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.
java.lang.IllegalArgumentException - The period or the number of occurrences is negativeaddNotification(String, String, Object, Date, long, long)
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 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
Timer. In order to use a fixed-rate execution scheme, use
addNotification(String, String, Object, Date, long, long, boolean) instead.
addNotification in interface TimerMBeantype - 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.
java.lang.IllegalArgumentException - The period or the number of occurrences is negativeaddNotification(String, String, Object, Date, long, long, boolean)
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 occurrences.
The timer notification will repeat continuously using the timer period using a fixed-delay
execution scheme, as specified in Timer. In order to use a fixed-rate
execution scheme, use 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.
addNotification in interface TimerMBeantype - 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).
java.lang.IllegalArgumentException - The period is negative or
the date notification is before the current date.
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 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.
addNotification in interface TimerMBeantype - The timer notification type.message - The timer notification detailed message.userData - The timer notification user data object.date - The date when the notification occurs.
java.lang.IllegalArgumentException - The date notification is before the current date.
public void removeNotification(java.lang.Integer id)
throws InstanceNotFoundException
removeNotification in interface TimerMBeanid - The timer notification identifier.
InstanceNotFoundException - The specified identifier does not correspond to any timer notification
in the list of notifications of this timer MBean.
public void removeNotifications(java.lang.String type)
throws InstanceNotFoundException
removeNotifications in interface TimerMBeantype - The timer notification type.
InstanceNotFoundException - The specified type does not correspond to any timer notification
in the list of notifications of this timer MBean.public void removeAllNotifications()
removeAllNotifications in interface TimerMBeanpublic int getNbNotifications()
getNbNotifications in interface TimerMBeanpublic java.util.Vector getAllNotificationIDs()
getAllNotificationIDs in interface TimerMBeanInteger objects containing all the timer notification identifiers.
public java.util.Vector getNotificationIDs(java.lang.String type)
getNotificationIDs in interface TimerMBeantype - 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)
getNotificationType in interface TimerMBeanid - The timer notification identifier.
public java.lang.String getNotificationMessage(java.lang.Integer id)
getNotificationMessage in interface TimerMBeanid - The timer notification identifier.
public java.lang.Object getNotificationUserData(java.lang.Integer id)
getNotificationUserData in interface TimerMBeanid - The timer notification identifier.
public java.util.Date getDate(java.lang.Integer id)
getDate in interface TimerMBeanid - The timer notification identifier.
public java.lang.Long getPeriod(java.lang.Integer id)
getPeriod in interface TimerMBeanid - The timer notification identifier.
public java.lang.Long getNbOccurences(java.lang.Integer id)
getNbOccurences in interface TimerMBeanid - The timer notification identifier.
public java.lang.Boolean getFixedRate(java.lang.Integer id)
getFixedRate in interface TimerMBeanid - The timer notification identifier.
public boolean getSendPastNotifications()
false.
getSendPastNotifications in interface TimerMBeansetSendPastNotifications(boolean)public void setSendPastNotifications(boolean value)
false.
setSendPastNotifications in interface TimerMBeanvalue - The past notifications sending on/off flag value.getSendPastNotifications()public boolean isActive()
start method is called.
It becomes inactive when the stop method is called.
false.
isActive in interface TimerMBeantrue if the timer MBean is active, false otherwise.public boolean isEmpty()
isEmpty in interface TimerMBeantrue if the list of timer notifications is empty, false otherwise.
|
J2EE1.4 SDK | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright 2003 Sun Microsystems, Inc. All rights reserved.