Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> management >> [ timer overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

javax.management.timer
Interface TimerMBean  

All Known Implementing Classes:

Timer

---

public interface TimerMBean

The timer service MBean interface.

Version:

$Revision: 1.2 $

---

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 for a specific date/time.
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 for a specific date/time, with an optional repeat period.
java.lang.Integer	addNotification(java.lang.String type, java.lang.String message, java.lang.Object userData, java.util.Date date, long period, long occurences)           Creates a new timer notification for a specific date/time, with an optional repeat period and a maximum number of occurences.
java.util.Vector	getAllNotificationIDs()           Retrieves all timer notifications ids.
java.util.Date	getDate(java.lang.Integer id)           Retrieves a copy of the notification date for a passed notification id.
int	getNbNotifications()           Retrieves the number of registered timer notifications.
java.lang.Long	getNbOccurences(java.lang.Integer id)           Retrieves a copy of the maximum notification occurences for a passed notification id.
java.util.Vector	getNotificationIDs(java.lang.String type)           Retrieves all timer notifications ids of the passed notification type.
java.lang.String	getNotificationMessage(java.lang.Integer id)           Retrieves the notification message for a passed notification id.
java.lang.String	getNotificationType(java.lang.Integer id)           Retrieves the notification type for a passed notification id.
java.lang.Object	getNotificationUserData(java.lang.Integer id)           Retrieves the notification user data for a passed notification id.
java.lang.Long	getPeriod(java.lang.Integer id)           Retrieves a copy of the notification period for a passed notification id.
boolean	getSendPastNotifications()           Retrieves the flag indicating whether past notifications are sent.
boolean	isActive()           Test whether the timer MBean is active.
boolean	isEmpty()           Test whether the timer MBean has any registered notifications.
void	removeAllNotifications()           Removes all notifications from the timer MBean.
void	removeNotification(java.lang.Integer id)           Removes a notification from the timer MBean with the specified notification id.
void	removeNotifications(java.lang.String type)           Removes all notifications from the timer MBean of the specified notification type.
void	setSendPastNotifications(boolean value)           Sets the flag indicating whether past notifications are sent.
void	start()           Starts the timer.
void	stop()           Stops the timer.

 

Method Detail

addNotification

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

Creates a new timer notification for a specific date/time. The notification is performed once.

---

addNotification

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

Creates a new timer notification for a specific date/time, with an optional repeat period. When the repeat period is not zero, the notification repeats forever.

If the date and time is before the the current date and time the period is repeatedly added until a date after the current date and time is found.

---

addNotification

public java.lang.Integer addNotification(java.lang.String type,
                                         java.lang.String message,
                                         java.lang.Object userData,
                                         java.util.Date date,
                                         long period,
                                         long occurences)
                                  throws java.lang.IllegalArgumentException

Creates a new timer notification for a specific date/time, with an optional repeat period and a maximum number of occurences.

If the date and time is before the the current date and time the period is repeatedly added until a date after the current date and time is found. If the number of occurences is exceeded before the current date and time is reached, an IllegalArgumentException is raised.

---

getAllNotificationIDs

public java.util.Vector getAllNotificationIDs()

Retrieves all timer notifications ids.

---

getDate

public java.util.Date getDate(java.lang.Integer id)

Retrieves a copy of the notification date for a passed notification id.

---

getNbNotifications

public int getNbNotifications()

Retrieves the number of registered timer notifications.

---

getNbOccurences

public java.lang.Long getNbOccurences(java.lang.Integer id)

Retrieves a copy of the maximum notification occurences for a passed notification id.

---

getNotificationIDs

public java.util.Vector getNotificationIDs(java.lang.String type)

Retrieves all timer notifications ids of the passed notification type.

---

getNotificationMessage

public java.lang.String getNotificationMessage(java.lang.Integer id)

Retrieves the notification message for a passed notification id.

---

getNotificationType

public java.lang.String getNotificationType(java.lang.Integer id)

Retrieves the notification type for a passed notification id.

---

getNotificationUserData

public java.lang.Object getNotificationUserData(java.lang.Integer id)

Retrieves the notification user data for a passed notification id.

---

getPeriod

public java.lang.Long getPeriod(java.lang.Integer id)

Retrieves a copy of the notification period for a passed notification id.

---

getSendPastNotifications

public boolean getSendPastNotifications()

Retrieves the flag indicating whether past notifications are sent.

---

isActive

public boolean isActive()

Test whether the timer MBean is active.

---

isEmpty

public boolean isEmpty()

Test whether the timer MBean has any registered notifications.

---

removeAllNotifications

public void removeAllNotifications()

Removes all notifications from the timer MBean.

---

removeNotification

public void removeNotification(java.lang.Integer id)
                        throws javax.management.InstanceNotFoundException

Removes a notification from the timer MBean with the specified notification id.

---

removeNotifications

public void removeNotifications(java.lang.String type)
                         throws javax.management.InstanceNotFoundException

Removes all notifications from the timer MBean of the specified notification type.

---

setSendPastNotifications

public void setSendPastNotifications(boolean value)

Sets the flag indicating whether past notifications are sent.

---

start

public void start()

Starts the timer. If there are any notifications before the current time these notifications are processed. The notification only takes place when send past notiications is true.

---

stop

public void stop()

Stops the timer.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> javax >> management >> [ timer overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---