|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
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 | |
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.
|
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.
|
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.
|
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.
|
Vector |
getAllNotificationIDs()
Gets all timer notification identifiers registered into the list of notifications. |
Date |
getDate(Integer id)
Gets a copy of the date associated to a timer notification. |
Boolean |
getFixedRate(Integer id)
Gets a copy of the flag indicating whether a peridic notification is executed at fixed-delay or at fixed-rate. |
int |
getNbNotifications()
Gets the number of timer notifications registered into the list of notifications. |
Long |
getNbOccurences(Integer id)
Gets a copy of the remaining number of occurences associated to a timer notification. |
Vector |
getNotificationIDs(String type)
Gets all the identifiers of timer notifications corresponding to the specified type. |
String |
getNotificationMessage(Integer id)
Gets the timer notification detailed message corresponding to the specified identifier. |
String |
getNotificationType(Integer id)
Gets the timer notification type corresponding to the specified identifier. |
Object |
getNotificationUserData(Integer id)
Gets the timer notification user data object corresponding to the specified identifier. |
Long |
getPeriod(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(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(Integer id)
Removes the timer notification corresponding to the specified identifier from the list of notifications. |
void |
removeNotifications(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, 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 Exception
Not used in this context.
preRegister
in interface MBeanRegistration
server
- The MBean server in which the timer MBean will be registered.name
- The object name of the timer MBean.
Exception
public void postRegister(Boolean registrationDone)
Not used in this context.
postRegister
in interface MBeanRegistration
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 Exception
Stops the timer.
preDeregister
in interface MBeanRegistration
Exception
public void postDeregister()
Not used in this context.
postDeregister
in interface MBeanRegistration
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.
start
in interface TimerMBean
public void stop()
stop
in interface TimerMBean
public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws 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 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
.
addNotification
in interface TimerMBean
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.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.
IllegalArgumentException
- The period or the number of occurences is negativeaddNotification(String, String, Object, Date, long, long)
public Integer addNotification(String type, String message, Object userData, Date date, long period, long nbOccurences) throws 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 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
Timer
. In order to use a fixed-rate execution scheme, use
addNotification(String, String, Object, Date, long, long, boolean)
instead.
addNotification
in interface TimerMBean
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.
IllegalArgumentException
- The period or the number of occurences is negativeaddNotification(String, String, Object, Date, long, long, boolean)
public Integer addNotification(String type, String message, Object userData, Date date, long period) throws 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 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 TimerMBean
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).
IllegalArgumentException
- The period is negative or
the date notification is before the current date.public Integer addNotification(String type, String message, Object userData, Date date) throws 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.
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 TimerMBean
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.
IllegalArgumentException
- The date notification is before the current date.public void removeNotification(Integer id) throws InstanceNotFoundException
removeNotification
in interface TimerMBean
id
- 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(String type) throws InstanceNotFoundException
removeNotifications
in interface TimerMBean
type
- 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 TimerMBean
public int getNbNotifications()
getNbNotifications
in interface TimerMBean
public Vector getAllNotificationIDs()
getAllNotificationIDs
in interface TimerMBean
Integer
objects containing all the timer notification identifiers.
public Vector getNotificationIDs(String type)
getNotificationIDs
in interface TimerMBean
type
- The timer notification type.
Integer
objects containing all the identifiers of
timer notifications with the specified type
.
type
.public String getNotificationType(Integer id)
getNotificationType
in interface TimerMBean
id
- The timer notification identifier.
public String getNotificationMessage(Integer id)
getNotificationMessage
in interface TimerMBean
id
- The timer notification identifier.
public Object getNotificationUserData(Integer id)
getNotificationUserData
in interface TimerMBean
id
- The timer notification identifier.
public Date getDate(Integer id)
getDate
in interface TimerMBean
id
- The timer notification identifier.
public Long getPeriod(Integer id)
getPeriod
in interface TimerMBean
id
- The timer notification identifier.
public Long getNbOccurences(Integer id)
getNbOccurences
in interface TimerMBean
id
- The timer notification identifier.
public Boolean getFixedRate(Integer id)
getFixedRate
in interface TimerMBean
id
- The timer notification identifier.
public boolean getSendPastNotifications()
false
.
getSendPastNotifications
in interface TimerMBean
setSendPastNotifications(boolean)
public void setSendPastNotifications(boolean value)
false
.
setSendPastNotifications
in interface TimerMBean
value
- 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 TimerMBean
true
if the timer MBean is active, false
otherwise.public boolean isEmpty()
isEmpty
in interface TimerMBean
true
if the list of timer notifications is empty, false
otherwise.
|
JavaTM 2 Platform Ent. Ed. v1.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved.