|
XMOJO 5 API Docs | ||||||||
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
This class 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)
This method 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)
This method 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)
This method 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()
This method gets all timer notification identifiers registered into the list of notifications. |
java.util.Date |
getDate(java.lang.Integer id)
This method gets a copy of the date associated to a timer notification. |
int |
getNbNotifications()
This method gets the number of timer notifications registered into the list of notifications. |
java.lang.Long |
getNbOccurences(java.lang.Integer id)
This method gets a copy of the remaining number of occurences associated to a timer notification. |
java.util.Vector |
getNotificationIDs(java.lang.String type)
This method gets all the identifiers of timer notifications corresponding to the specified type. |
java.lang.String |
getNotificationMessage(java.lang.Integer id)
This method gets the timer notification detailed message corresponding to the specified identifier. |
java.lang.String |
getNotificationType(java.lang.Integer id)
This method gets the timer notification type corresponding to the specified identifier. |
java.lang.Object |
getNotificationUserData(java.lang.Integer id)
This method gets the timer notification user data object corresponding to the specified identifier. |
java.lang.Long |
getPeriod(java.lang.Integer id)
This method gets a copy of the period (in milliseconds) associated to a timer notification. |
boolean |
getSendPastNotifications()
This method gets the flag indicating whether or not the timer sends past notifications. |
boolean |
isActive()
This method tests whether the timer MBean is active. |
boolean |
isEmpty()
This method 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 objectName)
Allows the timer MBean to perform any operations it needs before being registered in the MBean server. |
void |
removeAllNotifications()
This method 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)
This method 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)
This method Sets the flag indicating whether the timer sends past notifications or not. |
void |
start()
This method starts the timer. |
void |
stop()
This method 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
public static final long ONE_MINUTE
public static final long ONE_HOUR
public static final long ONE_DAY
public static final long ONE_WEEK
Constructor Detail |
public Timer()
Method Detail |
public ObjectName preRegister(MBeanServer server, ObjectName objectName) throws java.lang.Exception
preRegister
in interface MBeanRegistration
server
- The MBean server in which the timer MBean will be registered.name
- The object name of the timer MBean.java.lang.Exception
- public void postRegister(java.lang.Boolean registrationDone)
Not used in this context.
postRegister
in interface MBeanRegistration
javax.management.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 java.lang.Exception
Stops the timer.
preDeregister
in interface MBeanRegistration
java.lang.Exception
- public void postDeregister()
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 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.
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.java.lang.IllegalArgumentException
- 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, 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.
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).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, 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.
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.java.lang.IllegalArgumentException
- The period or the number
of occurences is negative or the date notification is
before the current date.public java.util.Vector getAllNotificationIDs()
getAllNotificationIDs
in interface TimerMBean
public java.util.Date getDate(java.lang.Integer id)
getDate
in interface TimerMBean
id
- - The timer notification identifier.public int getNbNotifications()
getNbNotifications
in interface TimerMBean
public java.lang.Long getNbOccurences(java.lang.Integer id)
getNbOccurences
in interface TimerMBean
id
- - The timer notification identifier.public java.util.Vector getNotificationIDs(java.lang.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 java.lang.String getNotificationMessage(java.lang.Integer id)
getNotificationMessage
in interface TimerMBean
id
- - The timer notification identifier.public java.lang.String getNotificationType(java.lang.Integer id)
getNotificationType
in interface TimerMBean
id
- - The timer notification identifier.public java.lang.Object getNotificationUserData(java.lang.Integer id)
getNotificationUserData
in interface TimerMBean
id
- - The timer notification identifier.public java.lang.Long getPeriod(java.lang.Integer id)
getPeriod
in interface TimerMBean
id
- - The timer notification identifier.public boolean getSendPastNotifications()
getSendPastNotifications
in interface TimerMBean
public boolean isActive()
isActive
in interface TimerMBean
public boolean isEmpty()
isEmpty
in interface TimerMBean
public void removeAllNotifications()
removeAllNotifications
in interface TimerMBean
public void removeNotification(java.lang.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(java.lang.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 setSendPastNotifications(boolean value)
setSendPastNotifications
in interface TimerMBean
value
- - The past notifications sending on/off flag value.
|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |