| javax.management.timer.TimerMBean
All known Subclasses: javax.management.timer.Timer,
| TimerMBean | | public interface TimerMBean (Code) | | Management interface for the
Timer class.
version:
$Revision: 1.6 $ |
| Method Summary | |
| public Integer | addNotification(String type, String message, Object userData, Date date)
| | public Integer | addNotification(String type, String message, Object userData, Date date, long period)
| | public Integer | addNotification(String type, String message, Object userData, Date date, long period, long occurences)
| | public Integer | addNotification(String type, String message, Object userData, Date date, long period, long occurences, boolean fixedRate)
Adds a notification to this Timer. | | public Vector | getAllNotificationIDs()
| | public Date | getDate(Integer id)
| | public Boolean | getFixedRate(Integer id)
| | public int | getNbNotifications()
| | public Long | getNbOccurences(Integer id)
Returns the number of times the notification with the given identifier is delivered. | | public Vector | getNotificationIDs(String type)
| | public String | getNotificationMessage(Integer id)
| | public String | getNotificationType(Integer id)
| | public Object | getNotificationUserData(Integer id)
| | public Long | getPeriod(Integer id)
| | public boolean | getSendPastNotifications()
| | public boolean | isActive()
Returns whether this Timer delivers notifications or not. | | public boolean | isEmpty()
Returns whether this Timer has notifications to deliver. | | public void | removeAllNotifications()
| | public void | removeNotification(Integer id)
| | public void | removeNotifications(String type)
| | public void | setSendPastNotifications(boolean value)
| | public void | start()
Starts this Timer. | | public void | stop()
Stops this Timer. |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date) throws IllegalArgumentException(Code) | | Shortcut for
TimerMBean.addNotification(String,String,Object,Date,long,long,boolean) addNotification(type, message, userData, date, 0L, 0L, false) |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period) throws IllegalArgumentException(Code) | | Shortcut for
TimerMBean.addNotification(String,String,Object,Date,long,long,boolean) addNotification(type, message, userData, date, period, 0L, false) |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period, long occurences) throws IllegalArgumentException(Code) | | Shortcut for
TimerMBean.addNotification(String,String,Object,Date,long,long,boolean) addNotification(type, message, userData, date, period, occurences, false) |
| addNotification | | public Integer addNotification(String type, String message, Object userData, Date date, long period, long occurences, boolean fixedRate) throws IllegalArgumentException(Code) | | Adds a notification to this Timer.
If the date is before the current date, and the notification is one-shot, it will be delivered immediately.
Parameters:
type - The type of the notification
Parameters:
message - The message of the notification
Parameters:
userData - The custom user data of the notification
Parameters:
date - The date at which the notification should be delivered the first time
Parameters:
period - The period of time between notifications delivers
Parameters:
occurences - The number of occurrences the notification should be delivered
Parameters:
fixedRate - True if the periodic notification should be sent at fixed rate, false if should be sent at fixed delay The identifier for the notification
throws:
IllegalArgumentException - If some of the parameters has illegal value |
| getAllNotificationIDs | | public Vector getAllNotificationIDs()(Code) | | Returns all identifiers for notifications added to this Timer
|
| getDate | | public Date getDate(Integer id)(Code) | | Returns the date for the notification with the given identifier
Parameters:
id - The notification identifier |
| getFixedRate | | public Boolean getFixedRate(Integer id)(Code) | | Returns whether the periodic notification with the given identifier is delivered at fixed rate or not
Parameters:
id - The notification identifier |
| getNbNotifications | | public int getNbNotifications()(Code) | | Returns the number of notifications added to this Timer
|
| getNbOccurences | | public Long getNbOccurences(Integer id)(Code) | | Returns the number of times the notification with the given identifier is delivered.
Parameters:
id - The notification identifier |
| getNotificationIDs | | public Vector getNotificationIDs(String type)(Code) | | Returns the identifiers of the notifications with the given type
Parameters:
type - The notification type |
| getNotificationMessage | | public String getNotificationMessage(Integer id)(Code) | | Returns the message of the notification with the given identifier
Parameters:
id - The notification identifier |
| getNotificationType | | public String getNotificationType(Integer id)(Code) | | Returns the type of the notification with the given identifier
Parameters:
id - The notification identifier |
| getNotificationUserData | | public Object getNotificationUserData(Integer id)(Code) | | Returns the user data of the notification with the given identifier
Parameters:
id - The notification identifier |
| getPeriod | | public Long getPeriod(Integer id)(Code) | | Returns the period between the deliver of two notifications for the notification with the given identifier
Parameters:
id - The notification identifier |
| getSendPastNotifications | | public boolean getSendPastNotifications()(Code) | | Returns whether this Timer delivers notifications that occurred while it has been stopped
See Also: TimerMBean.setSendPastNotifications |
| isEmpty | | public boolean isEmpty()(Code) | | Returns whether this Timer has notifications to deliver.
|
| removeAllNotifications | | public void removeAllNotifications()(Code) | | Removes all notifications from this Timer
|
| setSendPastNotifications | | public void setSendPastNotifications(boolean value)(Code) | | Sets whether this Timer delivers notifications that occurred while it has been stopped
See Also: TimerMBean.getSendPastNotifications |
| start | | public void start()(Code) | | Starts this Timer.
Only when a Timer is started it delivers notifications.
If
TimerMBean.getSendPastNotifications returns true, this Timer sends notifications that were waiting
to be delivered, otherwise it updates the notification times to the next deliver.
See Also: TimerMBean.stop |
|
|