Timer (Java SE 16 & JDK 16) (original) (raw)
All Implemented Interfaces:
[MBeanRegistration](../MBeanRegistration.html "interface in javax.management")
, [NotificationBroadcaster](../NotificationBroadcaster.html "interface in javax.management")
, [NotificationEmitter](../NotificationEmitter.html "interface in javax.management")
, [TimerMBean](TimerMBean.html "interface in javax.management.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:
- When sending timer notifications, the timer updates the notification sequence number irrespective of the notification type.
- 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. - The default behavior for periodic notifications is fixed-delay execution, as specified in Timer. In order to use fixed-rate execution, use the overloaded addNotification(String, String, Object, Date, long, long, boolean) method.
- 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 NotificationBroadcasterSupport.
Since:
1.5
Field Summary
Fieldsstatic long
Number of milliseconds in one day.static long
Number of milliseconds in one hour.static long
Number of milliseconds in one minute.static long
Number of milliseconds in one second.static long
Number of milliseconds in one week.
Constructor Summary
Constructors
Method Summary
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.
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.
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.[addNotification](#addNotification%28java.lang.String,java.lang.String,java.lang.Object,java.util.Date,long,long,boolean%29)([String](../../../../java.base/java/lang/String.html "class in java.lang") type,[String](../../../../java.base/java/lang/String.html "class in java.lang") message,[Object](../../../../java.base/java/lang/Object.html "class in java.lang") userData,[Date](../../../../java.base/java/util/Date.html "class in java.util") 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.
Gets all timer notification identifiers registered into the list of notifications.
Gets a copy of the date associated to a timer notification.
Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.int
Gets the number of timer notifications registered into the list of notifications.
Gets a copy of the remaining number of occurrences associated to a timer notification.
Gets all the identifiers of timer notifications corresponding to the specified type.
Gets the timer notification detailed message corresponding to the specified identifier.
Gets the timer notification type corresponding to the specified identifier.
Gets the timer notification user data object corresponding to the specified identifier.
Gets a copy of the period (in milliseconds) associated to a timer notification.boolean
Gets the flag indicating whether or not the timer sends past notifications.boolean
[isActive](#isActive%28%29)()
Tests whether the timer MBean is active.boolean
[isEmpty](#isEmpty%28%29)()
Tests whether the list of timer notifications is empty.void
Allows the timer MBean to perform any operations needed after having been unregistered by the MBean server.void
Allows the timer MBean to perform any operations needed after having been registered in the MBean server or after the registration has failed.void
Allows the timer MBean to perform any operations it needs before being unregistered by the MBean server.
Allows the timer MBean to perform any operations it needs before being registered in the MBean server.void
Removes all the timer notifications from the list of notifications and resets the counter used to update the timer notification identifiers.void
Removes the timer notification corresponding to the specified identifier from the list of notifications.void
Removes all the timer notifications corresponding to the specified type from the list of notifications.void
[setSendPastNotifications](#setSendPastNotifications%28boolean%29)(boolean value)
Sets the flag indicating whether the timer sends past notifications or not.void
[start](#start%28%29)()
void
[stop](#stop%28%29)()
Methods declared in class java.lang.Object
[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)
Field Details
ONE_SECOND
public static final long ONE_SECOND
Number of milliseconds in one second. Useful constant for theaddNotification
method.
See Also:
Constant Field ValuesONE_MINUTE
public static final long ONE_MINUTE
Number of milliseconds in one minute. Useful constant for theaddNotification
method.
See Also:
Constant Field ValuesONE_HOUR
public static final long ONE_HOUR
Number of milliseconds in one hour. Useful constant for theaddNotification
method.
See Also:
Constant Field ValuesONE_DAY
public static final long ONE_DAY
Number of milliseconds in one day. Useful constant for theaddNotification
method.
See Also:
Constant Field ValuesONE_WEEK
public static final long ONE_WEEK
Number of milliseconds in one week. Useful constant for theaddNotification
method.
See Also:
Constant Field ValuesConstructor Details
Timer
public Timer()
Default constructor.Method Details
preRegister
Allows the timer MBean to perform any operations it needs before being registered in the MBean server.
Not used in this context.
Specified by:
[preRegister](../MBeanRegistration.html#preRegister%28javax.management.MBeanServer,javax.management.ObjectName%29)
in interface[MBeanRegistration](../MBeanRegistration.html "interface in javax.management")
Parameters:
server
- The MBean server in which the timer MBean will be registered.
name
- The object name of the timer MBean.
Returns:
The name of the timer MBean registered.
Throws:
[Exception](../../../../java.base/java/lang/Exception.html "class in java.lang")
- if something goes wrongpostRegister
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.
Specified by:
[postRegister](../MBeanRegistration.html#postRegister%28java.lang.Boolean%29)
in interface[MBeanRegistration](../MBeanRegistration.html "interface in javax.management")
Parameters:
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.preDeregister
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.
Specified by:
[preDeregister](../MBeanRegistration.html#preDeregister%28%29)
in interface[MBeanRegistration](../MBeanRegistration.html "interface in javax.management")
Throws:
[Exception](../../../../java.base/java/lang/Exception.html "class in java.lang")
- if something goes wrongpostDeregister
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](../MBeanRegistration.html#postDeregister%28%29)
in interface[MBeanRegistration](../MBeanRegistration.html "interface in javax.management")
start
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 thesendPastNotifications
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](TimerMBean.html#start%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
stop
public void stop()
Stops the timer.
Specified by:
[stop](TimerMBean.html#stop%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
addNotification
Creates a new timer notification with the specified
type
,message
anduserData
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.
Specified by:
[addNotification](TimerMBean.html#addNotification%28java.lang.String,java.lang.String,java.lang.Object,java.util.Date,long,long,boolean%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.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
- Iftrue
and if the notification is periodic, the notification is scheduled with a fixed-rate execution scheme. Iffalse
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](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- The date isnull
or the period or the number of occurrences is negative.
See Also:
addNotification(String, String, Object, Date, long, long)addNotification
Creates a new timer notification with the specified
type
,message
anduserData
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 inTimer. In order to use a fixed-rate execution scheme, useaddNotification(String, String, Object, Date, long, long, boolean) instead.
Specified by:
[addNotification](TimerMBean.html#addNotification%28java.lang.String,java.lang.String,java.lang.Object,java.util.Date,long,long%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.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.
Returns:
The identifier of the new created timer notification.
Throws:
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- The date isnull
or the period or the number of occurrences is negative.
See Also:
addNotification(String, String, Object, Date, long, long, boolean)addNotification
Creates a new timer notification with the specified
type
,message
anduserData
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.
Specified by:
[addNotification](TimerMBean.html#addNotification%28java.lang.String,java.lang.String,java.lang.Object,java.util.Date,long%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.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).
Returns:
The identifier of the new created timer notification.
Throws:
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- The date isnull
or the period is negative.addNotification
Creates a new timer notification with the specified
type
,message
anduserData
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.
Specified by:
[addNotification](TimerMBean.html#addNotification%28java.lang.String,java.lang.String,java.lang.Object,java.util.Date%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.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.
Returns:
The identifier of the new created timer notification.
Throws:
[IllegalArgumentException](../../../../java.base/java/lang/IllegalArgumentException.html "class in java.lang")
- The date isnull
.removeNotification
Removes the timer notification corresponding to the specified identifier from the list of notifications.
Specified by:
[removeNotification](TimerMBean.html#removeNotification%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Throws:
[InstanceNotFoundException](../InstanceNotFoundException.html "class in javax.management")
- The specified identifier does not correspond to any timer notification in the list of notifications of this timer MBean.removeNotifications
Removes all the timer notifications corresponding to the specified type from the list of notifications.
Specified by:
[removeNotifications](TimerMBean.html#removeNotifications%28java.lang.String%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
type
- The timer notification type.
Throws:
[InstanceNotFoundException](../InstanceNotFoundException.html "class in javax.management")
- The specified type does not correspond to any timer notification in the list of notifications of this timer MBean.removeAllNotifications
public 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](TimerMBean.html#removeAllNotifications%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
getNbNotifications
public int getNbNotifications()
Gets the number of timer notifications registered into the list of notifications.
Specified by:
[getNbNotifications](TimerMBean.html#getNbNotifications%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Returns:
The number of timer notifications.getAllNotificationIDs
Gets all timer notification identifiers registered into the list of notifications.
Specified by:
[getAllNotificationIDs](TimerMBean.html#getAllNotificationIDs%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Returns:
A vector ofInteger
objects containing all the timer notification identifiers.
The vector is empty if there is no timer notification registered for this timer MBean.getNotificationIDs
Gets all the identifiers of timer notifications corresponding to the specified type.
Specified by:
[getNotificationIDs](TimerMBean.html#getNotificationIDs%28java.lang.String%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
type
- The timer notification type.
Returns:
A vector ofInteger
objects containing all the identifiers of timer notifications with the specifiedtype
.
The vector is empty if there is no timer notifications registered for this timer MBean with the specifiedtype
.getNotificationType
Gets the timer notification type corresponding to the specified identifier.
Specified by:
[getNotificationType](TimerMBean.html#getNotificationType%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
The timer notification type or null if the identifier is not mapped to any timer notification registered for this timer MBean.getNotificationMessage
Gets the timer notification detailed message corresponding to the specified identifier.
Specified by:
[getNotificationMessage](TimerMBean.html#getNotificationMessage%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
The timer notification detailed message or null if the identifier is not mapped to any timer notification registered for this timer MBean.getNotificationUserData
Gets the timer notification user data object corresponding to the specified identifier.
Specified by:
[getNotificationUserData](TimerMBean.html#getNotificationUserData%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
The timer notification user data object or null if the identifier is not mapped to any timer notification registered for this timer MBean.getDate
Gets a copy of the date associated to a timer notification.
Specified by:
[getDate](TimerMBean.html#getDate%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
A copy of the date or null if the identifier is not mapped to any timer notification registered for this timer MBean.getPeriod
Gets a copy of the period (in milliseconds) associated to a timer notification.
Specified by:
[getPeriod](TimerMBean.html#getPeriod%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
A copy of the period or null if the identifier is not mapped to any timer notification registered for this timer MBean.getNbOccurences
Gets a copy of the remaining number of occurrences associated to a timer notification.
Specified by:
[getNbOccurences](TimerMBean.html#getNbOccurences%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
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.getFixedRate
Gets a copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.
Specified by:
[getFixedRate](TimerMBean.html#getFixedRate%28java.lang.Integer%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
id
- The timer notification identifier.
Returns:
A copy of the flag indicating whether a periodic notification is executed at fixed-delay or at fixed-rate.getSendPastNotifications
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 isfalse
.
Specified by:
[getSendPastNotifications](TimerMBean.html#getSendPastNotifications%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Returns:
The past notifications sending on/off flag value.
See Also:
setSendPastNotifications(boolean)setSendPastNotifications
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 isfalse
.
Specified by:
[setSendPastNotifications](TimerMBean.html#setSendPastNotifications%28boolean%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Parameters:
value
- The past notifications sending on/off flag value.
See Also:
getSendPastNotifications()isActive
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 isfalse
.
Specified by:
[isActive](TimerMBean.html#isActive%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Returns:
true
if the timer MBean is active,false
otherwise.isEmpty
public boolean isEmpty()
Tests whether the list of timer notifications is empty.
Specified by:
[isEmpty](TimerMBean.html#isEmpty%28%29)
in interface[TimerMBean](TimerMBean.html "interface in javax.management.timer")
Returns:
true
if the list of timer notifications is empty,false
otherwise.