| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TimerMBean
Exposes the management interface of the timer MBean.
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 occurrences.
|
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 occurrences.
|
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 occurrences.
|
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 occurrences.
|
Vector |
Gets all timer notification identifiers registered into the list of notifications. |
Date |
Gets a copy of the date associated to a timer notification. |
Boolean |
getFixedRate(Integer id) Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate. |
int |
Gets the number of timer notifications registered into the list of notifications. |
Long |
Gets a copy of the remaining number of occurrences associated to a timer notification. |
Vector |
getNotificationIDs(String type) Gets all the identifiers of timer notifications corresponding to the specified type. |
String |
Gets the timer notification detailed message corresponding to the specified identifier. |
String |
Gets the timer notification type corresponding to the specified identifier. |
Object |
Gets the timer notification user data object corresponding to the specified identifier. |
Long |
Gets a copy of the period (in milliseconds) associated to a timer notification. |
boolean |
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 |
Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers. |
void |
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. |
Method Detail |
---|
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 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.
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 is {@code null}.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 occurrences.
The timer notification will repeat continuously using the timer period using a fixed-delay execution scheme, as specified in {@link java.util.Timer}. In order to use a fixed-rate execution scheme, use {@link #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.
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 date is {@code null} or
the period is negative.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 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 {@link java.util.Timer}. In order to use a fixed-rate execution scheme, use {@link #addNotification(String, String, Object, Date, long, long, boolean)} instead.
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 date is {@code null} or
the period or the number of occurrences is negative.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 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 {@link java.util.Timer}.
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 date is {@code null} or
the period or the number of occurrences is negative.public Vector getAllNotificationIDs()
Integer
objects containing all the timer notification identifiers.
public Date getDate(Integer id)
id
- The timer notification identifier.public Boolean getFixedRate(Integer id)
id
- The timer notification identifier.public int getNbNotifications()
public Long getNbOccurences(Integer id)
id
- The timer notification identifier.public Vector getNotificationIDs(String type)
type
- The timer notification type.Integer
objects containing all the identifiers of
timer notifications with the specified type
.
type
.public String getNotificationMessage(Integer id)
id
- The timer notification identifier.public String getNotificationType(Integer id)
id
- The timer notification identifier.public Object getNotificationUserData(Integer id)
id
- The timer notification identifier.public Long getPeriod(Integer id)
id
- The timer notification identifier.public boolean getSendPastNotifications()
public boolean isActive()
true
if the timer MBean is active, false
otherwise.public boolean isEmpty()
true
if the list of timer notifications is empty, false
otherwise.public void removeAllNotifications()
public void removeNotification(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(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.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 occurrences.
If the timer notification date remains earlier than the current date, this notification is just removed
from the list of notifications.
public void stop()
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |