Module java.management
Package javax.management.timer

Interface TimerMBean

All Known Implementing Classes:
Timer
public interface TimerMBean
Exposes the management interface of the timer MBean.
Since:
1.5

  • Method Summary

    Modifier and Type
    Method
    Description
    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<Integer>
    getAllNotificationIDs()
    Gets all timer notification identifiers registered into the list of notifications.
    Date
    getDate​(Integer id)
    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
    getNbNotifications()
    Gets the number of timer notifications registered into the list of notifications.
    Long
    getNbOccurences​(Integer id)
    Gets a copy of the remaining number of occurrences associated to a timer notification.
    Vector<Integer>
    getNotificationIDs​(String type)
    Gets all the identifiers of timer notifications corresponding to the specified type.
    String
    getNotificationMessage​(Integer id)
    Gets the timer notification detailed message corresponding to the specified identifier.
    String
    getNotificationType​(Integer id)
    Gets the timer notification type corresponding to the specified identifier.
    Object
    getNotificationUserData​(Integer id)
    Gets the timer notification user data object corresponding to the specified identifier.
    Long
    getPeriod​(Integer id)
    Gets a copy of the period (in milliseconds) associated to a timer notification.
    boolean
    getSendPastNotifications()
    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
    removeAllNotifications()
    Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.
    void
    removeNotification​(Integer id)
    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 Details

    • start

      void start()
      Starts the timer.

      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.

    • stop

      void stop()
      Stops the timer.

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences, boolean fixedRate) throws IllegalArgumentException
      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.

      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 Timer.

      Parameters:
      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.
      Returns:
      The identifier of the new created timer notification.
      Throws:
      IllegalArgumentException - The date is null or the period or the number of occurrences is negative.
      See Also:
      addNotification(String, String, Object, Date, long, long)

    • addNotification

      Integer addNotification​(String type, String message, Object userData, Date date, long period, long nbOccurences) throws IllegalArgumentException
      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.

      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 Timer. In order to use a fixed-rate execution scheme, use addNotification(String, String, Object, Date, long, long, boolean) instead.

      Parameters:
      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.
      Returns:
      The identifier of the new created timer notification.
      Throws:
      IllegalArgumentException - The date is null or the period or the number of occurrences is negative.
      See Also:
      addNotification(String, String, Object, Date, long, long, boolean)

    • addNotification

      Integer addNotification​(String type, String message, Object userData,