public static final long ONE_SECOND

Number of milliseconds in one second. Useful constant for the addNotification method.

public static final long ONE_MINUTE

Number of milliseconds in one minute. Useful constant for the addNotification method.

public static final long ONE_HOUR

Number of milliseconds in one hour. Useful constant for the addNotification method.

public static final long ONE_DAY

Number of milliseconds in one day. Useful constant for the addNotification method.

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.

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.

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.

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.

public MBeanNotificationInfo[] getNotificationInfo()

Description copied from interface: NotificationBroadcaster

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.

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

public void stop()

Stops the timer.

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

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

public 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 Timer. In order to use a fixed-rate execution scheme, use 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.

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

public void removeNotification​(Integer id)
                        throws InstanceNotFoundException

Removes the timer notification corresponding to the specified identifier from the list of notifications.

public void removeNotifications​(String type)
                         throws InstanceNotFoundException

Removes all the timer notifications corresponding to the specified type from the list of notifications.

public void removeAllNotifications()

Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.

public int getNbNotifications()

Gets the number of timer notifications registered into the list of notifications.

public Vector<Integer> getAllNotificationIDs()

Gets all timer notification identifiers registered into the list of notifications.

public Vector<Integer> getNotificationIDs​(String type)

Gets all the identifiers of timer notifications corresponding to the specified type.

public String getNotificationType​(Integer id)

Gets the timer notification type corresponding to the specified identifier.

public String getNotificationMessage​(Integer id)

Gets the timer notification detailed message corresponding to the specified identifier.

public Object getNotificationUserData​(Integer id)

Gets the timer notification user data object corresponding to the specified identifier.

public Date getDate​(Integer id)

Gets a copy of the date associated to a timer notification.

public Long getPeriod​(Integer id)

Gets a copy of the period (in milliseconds) associated to a timer notification.

public Long getNbOccurences​(Integer id)

Gets a copy of the remaining number of occurrences associated to a timer notification.

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.

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.

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.

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.