|
XMOJO 5 API Docs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface exposes the management interface of the timer MBean.
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 |
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. |
Method Detail |
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) 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.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.
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.
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()
Integer
objects containing all the
timer notification identifiers. public java.util.Date getDate(java.lang.Integer id)
id
- - The timer notification identifier.public int getNbNotifications()
public java.lang.Long getNbOccurences(java.lang.Integer id)
id
- - The timer notification identifier.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 getNotificationMessage(java.lang.Integer id)
id
- - The timer notification identifier.public java.lang.String getNotificationType(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.lang.Long getPeriod(java.lang.Integer id)
id
- - The timer notification identifier.public boolean getSendPastNotifications()
public boolean isActive()
public boolean isEmpty()
public void removeAllNotifications()
public void removeNotification(java.lang.Integer id) throws InstanceNotFoundException
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
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)
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 |