Class: javax.management.timer.Timer

Provides the implementation of the timer MBean. The timer MBean sends out an alarm at a specified time that wakes up all the listeners registered to receive timer notifications.

This class manages a list of dated timer notifications. A method allows users to add/remove as many notifications as required. When a timer notification is emitted by the timer and becomes obsolete, it is automatically removed from the list of timer notifications.
Additional timer notifications can be added into regularly repeating notifications.

Note:

  1. When sending timer notifications, the timer updates the notification sequence number irrespective of the notification type.
  2. The timer service relies on the system date of the host where the Timer class is loaded. Listeners may receive untimely notifications if their host has a different system date. To avoid such problems, synchronize the system date of all host machines where timing is needed.
  3. The default behavior for periodic notifications is fixed-delay execution, as specified in java.util.Timer. In order to use fixed-rate execution, use the overloaded javax.management.timer.Timer.addNotification(java.lang.String, java.lang.String, java.lang.Object, java.util.Date, long, long, boolean) method.
  4. Notification listeners are potentially all executed in the same thread. Therefore, they should execute rapidly to avoid holding up other listeners or perturbing the regularity of fixed-delay executions. See javax.management.NotificationBroadcasterSupport.
Since:
@since 1.5

Methods

  • Timertop

    public Timer()
    Default constructor.
    Related Links:
    Google Code Search
    Stack Overflow

  • addNotificationtop

    public synchronized Integer addNotification(String type, String message, Object userData, Date date) 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 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.

    Parameters:
    @param type The timer notification type.
    @param message The timer notification detailed message.
    @param userData The timer notification user data object.
    @param date The date when the notification occurs.
    Return:
    @return The identifier of the new created timer notification.
    Exceptions:
    @exception IllegalArgumentException The date is null .
    Specified by:
    addNotification from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • addNotificationtop

    public synchronized Integer addNotification(String type, String message, Object userData, Date date, long period) 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 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 java.util.Timer. In order to use a fixed-rate execution scheme, use javax.management.timer.Timer.addNotification(java.lang.String, java.lang.String, java.lang.Object, java.util.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.

    Parameters:
    @param type The timer notification type.
    @param message The timer notification detailed message.
    @param userData The timer notification user data object.
    @param date The date when the notification occurs.
    @param period The period of the timer notification (in milliseconds).
    Return:
    @return The identifier of the new created timer notification.
    Exceptions:
    @exception IllegalArgumentException The date is null or the period is negative.
    Specified by:
    addNotification from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • addNotificationtop

    public synchronized 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 java.util.Timer. In order to use a fixed-rate execution scheme, use javax.management.timer.Timer.addNotification(java.lang.String, java.lang.String, java.lang.Object, java.util.Date, long, long, boolean) instead.

    Parameters:
    @param type The timer notification type.
    @param message The timer notification detailed message.
    @param userData The timer notification user data object.
    @param date The date when the notification occurs.
    @param period The period of the timer notification (in milliseconds).
    @param nbOccurences The total number the timer notification will be emitted.
    Return:
    @return The identifier of the new created timer notification.
    Exceptions:
    @exception IllegalArgumentException The date is null or the period or the number of occurrences is negative.
    See:
    @see javax.management.timer.Timer.addNotification(java.lang.String, java.lang.String, java.lang.Object, java.util.Date, long, long, boolean)
    Specified by:
    addNotification from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • addNotificationtop

    public synchronized 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 java.util.Timer.

    Parameters:
    @param type The timer notification type.
    @param message The timer notification detailed message.
    @param userData The timer notification user data object.
    @param date The date when the notification occurs.
    @param period The period of the timer notification (in milliseconds).
    @param nbOccurences The total number the timer notification will be emitted.
    @param 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.
    Return:
    @return The identifier of the new created timer notification.
    Exceptions:
    @exception IllegalArgumentException The date is null or the period or the number of occurrences is negative.
    See:
    @see javax.management.timer.Timer.addNotification(java.lang.String, java.lang.String, java.lang.Object, java.util.Date, long, long)
    Specified by:
    addNotification from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getAllNotificationIDstop

    public synchronized Vector<Integer> getAllNotificationIDs()
    Gets all timer notification identifiers registered into the list of notifications.
    Return:
    @return A vector of Integer objects containing all the timer notification identifiers.
    The vector is empty if there is no timer notification registered for this timer MBean.
    Specified by:
    getAllNotificationIDs from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getDatetop

    public Date getDate(Integer id)
    Gets a copy of the date associated to a timer notification.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getDate from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getFixedRatetop

    public Boolean getFixedRate(Integer id)
    Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.
    Specified by:
    getFixedRate from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNbNotificationstop

    public int getNbNotifications()
    Gets the number of timer notifications registered into the list of notifications.
    Return:
    @return The number of timer notifications.
    Specified by:
    getNbNotifications from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNbOccurencestop

    public Long getNbOccurences(Integer id)
    Gets a copy of the remaining number of occurrences associated to a timer notification.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return A copy of the remaining number of occurrences or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getNbOccurences from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNotificationIDstop

    public synchronized Vector<Integer> getNotificationIDs(String type)
    Gets all the identifiers of timer notifications corresponding to the specified type.
    Parameters:
    @param type The timer notification type.
    Return:
    @return A vector of Integer objects containing all the identifiers of timer notifications with the specified type.
    The vector is empty if there is no timer notifications registered for this timer MBean with the specified type.
    Specified by:
    getNotificationIDs from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNotificationInfotop

    public synchronized MBeanNotificationInfo[] getNotificationInfo()

    Returns an array indicating, for each notification this MBean may send, the name of the Java class of the notification and the notification type.

    It is not illegal for the MBean to send notifications not described in this array. However, some clients of the MBean server may depend on the array being complete for their correct functioning.

    Return:
    @return the array of possible notifications.
    Specified by:
    getNotificationInfo from NotificationBroadcaster
    Override hierarchy:
    getNotificationInfo from NotificationBroadcasterSupport
    Related Links:
    Google Code Search
    Stack Overflow

  • getNotificationMessagetop

    public String getNotificationMessage(Integer id)
    Gets the timer notification detailed message corresponding to the specified identifier.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getNotificationMessage from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNotificationTypetop

    public String getNotificationType(Integer id)
    Gets the timer notification type corresponding to the specified identifier.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getNotificationType from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getNotificationUserDatatop

    public Object getNotificationUserData(Integer id)
    Gets the timer notification user data object corresponding to the specified identifier.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getNotificationUserData from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getPeriodtop

    public Long getPeriod(Integer id)
    Gets a copy of the period (in milliseconds) associated to a timer notification.
    Parameters:
    @param id The timer notification identifier.
    Return:
    @return A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean.
    Specified by:
    getPeriod from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • getSendPastNotificationstop

    public boolean getSendPastNotifications()
    Gets the flag indicating whether or not the timer sends past notifications.
    The default value of the past notifications sending on/off flag is false.
    Return:
    @return The past notifications sending on/off flag value.
    See:
    @see javax.management.timer.Timer.setSendPastNotifications(boolean)
    Specified by:
    getSendPastNotifications from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • isActivetop

    public boolean isActive()
    Tests whether the timer MBean is active. A timer MBean is marked active when the start method is called. It becomes inactive when the stop method is called.
    The default value of the active on/off flag is false.
    Return:
    @return true if the timer MBean is active, false otherwise.
    Specified by:
    isActive from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • isEmptytop

    public boolean isEmpty()
    Tests whether the list of timer notifications is empty.
    Return:
    @return true if the list of timer notifications is empty, false otherwise.
    Specified by:
    isEmpty from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • postDeregistertop

    public void postDeregister()
    Allows the timer MBean to perform any operations needed after having been unregistered by the MBean server.

    Not used in this context.

    Specified by:
    postDeregister from MBeanRegistration
    Related Links:
    Google Code Search
    Stack Overflow

  • postRegistertop

    public void postRegister(Boolean registrationDone)
    Allows the timer MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.

    Not used in this context.

    Parameters:
    @param registrationDone Indicates whether or not the MBean has been successfully registered in the MBean server. The value false means that the registration phase has failed.
    Specified by:
    postRegister from MBeanRegistration
    Related Links:
    Google Code Search
    Stack Overflow

  • preDeregistertop

    public void preDeregister() throws Exception
    Allows the timer MBean to perform any operations it needs before being unregistered by the MBean server.

    Stops the timer.

    Exceptions:
    @exception Exception
    Specified by:
    preDeregister from MBeanRegistration
    Related Links:
    Google Code Search
    Stack Overflow

  • preRegistertop

    public ObjectName preRegister(MBeanServer server, ObjectName name) throws Exception
    Allows the timer MBean to perform any operations it needs before being registered in the MBean server.

    Not used in this context.

    Parameters:
    @param server The MBean server in which the timer MBean will be registered.
    @param name The object name of the timer MBean.
    Return:
    @return The name of the timer MBean registered.
    Exceptions:
    @exception Exception
    Specified by:
    preRegister from MBeanRegistration
    Related Links:
    Google Code Search
    Stack Overflow

  • removeAllNotificationstop

    public synchronized void removeAllNotifications()
    Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.
    Specified by:
    removeAllNotifications from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • removeNotificationtop

    public synchronized void removeNotification(Integer id) throws InstanceNotFoundException
    Removes the timer notification corresponding to the specified identifier from the list of notifications.
    Parameters:
    @param id The timer notification identifier.
    Exceptions:
    @exception InstanceNotFoundException The specified identifier does not correspond to any timer notification in the list of notifications of this timer MBean.
    Specified by:
    removeNotification from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • removeNotificationstop

    public synchronized void removeNotifications(String type) throws InstanceNotFoundException
    Removes all the timer notifications corresponding to the specified type from the list of notifications.
    Parameters:
    @param type The timer notification type.
    Exceptions:
    @exception InstanceNotFoundException The specified type does not correspond to any timer notification in the list of notifications of this timer MBean.
    Specified by:
    removeNotifications from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • setSendPastNotificationstop

    public void setSendPastNotifications(boolean value)
    Sets the flag indicating whether the timer sends past notifications or not.
    The default value of the past notifications sending on/off flag is false.
    Parameters:
    @param value The past notifications sending on/off flag value.
    See:
    @see javax.management.timer.Timer.getSendPastNotifications()
    Specified by:
    setSendPastNotifications from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • starttop

    public synchronized 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.

    Specified by:
    start from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

  • stoptop

    public synchronized void stop()
    Stops the timer.
    Specified by:
    stop from TimerMBean
    Related Links:
    Google Code Search
    Stack Overflow

Fields

  • ONE_DAY

    public static final long ONE_DAY = 86400000
    Number of milliseconds in one day. Useful constant for the addNotification method.

  • ONE_HOUR

    public static final long ONE_HOUR = 3600000
    Number of milliseconds in one hour. Useful constant for the addNotification method.

  • ONE_MINUTE

    public static final long ONE_MINUTE = 60000
    Number of milliseconds in one minute. Useful constant for the addNotification method.

  • ONE_SECOND

    public static final long ONE_SECOND = 1000
    Number of milliseconds in one second. Useful constant for the addNotification method.

  • ONE_WEEK

    public static final long ONE_WEEK = 604800000
    Number of milliseconds in one week. Useful constant for the addNotification method.