- java.lang.Object
-
- java.lang.management.MemoryNotificationInfo
-
public class MemoryNotificationInfo extends Object
The information about a memory notification.A memory notification is emitted by
MemoryMXBean
when the Java virtual machine detects that the memory usage of a memory pool is exceeding a threshold value. The notification emitted will contain the memory notification information about the detected condition:- The name of the memory pool.
- The memory usage of the memory pool when the notification was constructed.
- The number of times that the memory usage has crossed
a threshold when the notification was constructed.
For usage threshold notifications, this count will be the
usage threshold count
. For collection threshold notifications, this count will be thecollection usage threshold count
.
A
CompositeData
representing the MemoryNotificationInfo object is stored in theuser data
of anotification
. Thefrom
method is provided to convert from a CompositeData to a MemoryNotificationInfo object. For example:Notification notif; // receive the notification emitted by MemoryMXBean and set to notif ... String notifType = notif.getType(); if (notifType.equals(MemoryNotificationInfo.MEMORY_THRESHOLD_EXCEEDED) || notifType.equals(MemoryNotificationInfo.MEMORY_COLLECTION_THRESHOLD_EXCEEDED)) { // retrieve the memory notification information CompositeData cd = (CompositeData) notif.getUserData(); MemoryNotificationInfo info = MemoryNotificationInfo.from(cd); .... }
The types of notifications emitted by MemoryMXBean are:
- A
usage threshold exceeded notification
.
This notification will be emitted when the memory usage of a memory pool is increased and has reached or exceeded its usage threshold value. Subsequent crossing of the usage threshold value does not cause further notification until the memory usage has returned to become less than the usage threshold value. - A
collection usage threshold exceeded notification
.
This notification will be emitted when the memory usage of a memory pool is greater than or equal to its collection usage threshold after the Java virtual machine has expended effort in recycling unused objects in that memory pool.
- Since:
- 1.5
-
-
Field Summary
Fields Modifier and Type Field and Description static String
MEMORY_COLLECTION_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool is greater than or equal to its collection usage threshold after the Java virtual machine has expended effort in recycling unused objects in that memory pool.static String
MEMORY_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool has reached or exceeded its usage threshold value.
-
Constructor Summary
Constructors Constructor and Description MemoryNotificationInfo(String poolName, MemoryUsage usage, long count)
Constructs a MemoryNotificationInfo object.
-
Method Summary
Methods Modifier and Type Method and Description static MemoryNotificationInfo
from(CompositeData cd)
Returns a MemoryNotificationInfo object represented by the given CompositeData.long
getCount()
Returns the number of times that the memory usage has crossed a threshold when the notification was constructed.String
getPoolName()
Returns the name of the memory pool that triggers this notification.MemoryUsage
getUsage()
Returns the memory usage of the memory pool when this notification was constructed.
-
-
-
Field Detail
-
MEMORY_THRESHOLD_EXCEEDED
public static final String MEMORY_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool has reached or exceeded its usage threshold value. This notification is emitted byMemoryMXBean
. Subsequent crossing of the usage threshold value does not cause further notification until the memory usage has returned to become less than the usage threshold value. The value of this notification type is java.management.memory.threshold.exceeded.- See Also:
- Constant Field Values
-
MEMORY_COLLECTION_THRESHOLD_EXCEEDED
public static final String MEMORY_COLLECTION_THRESHOLD_EXCEEDED
Notification type denoting that the memory usage of a memory pool is greater than or equal to its collection usage threshold after the Java virtual machine has expended effort in recycling unused objects in that memory pool. This notification is emitted byMemoryMXBean
. The value of this notification type is java.management.memory.collection.threshold.exceeded.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MemoryNotificationInfo
public MemoryNotificationInfo(String poolName, MemoryUsage usage, long count)
Constructs a MemoryNotificationInfo object.- Parameters:
poolName
- The name of the memory pool which triggers this notification.usage
- Memory usage of the memory pool.count
- The threshold crossing count.
-
-
Method Detail
-
getPoolName
public String getPoolName()
Returns the name of the memory pool that triggers this notification. The memory pool usage has crossed a threshold.- Returns:
- the name of the memory pool that triggers this notification.
-
getUsage
public MemoryUsage getUsage()
Returns the memory usage of the memory pool when this notification was constructed.- Returns:
- the memory usage of the memory pool when this notification was constructed.
-
getCount
public long getCount()
Returns the number of times that the memory usage has crossed a threshold when the notification was constructed. For usage threshold notifications, this count will be thethreshold count
. For collection threshold notifications, this count will be thecollection usage threshold count
.- Returns:
- the number of times that the memory usage has crossed a threshold when the notification was constructed.
-
from
public static MemoryNotificationInfo from(CompositeData cd)
Returns a MemoryNotificationInfo object represented by the given CompositeData. The given CompositeData must contain the following attributes:Attribute Name Type poolName java.lang.String usage javax.management.openmbean.CompositeData count java.lang.Long - Parameters:
cd
- CompositeData representing a MemoryNotificationInfo- Returns:
- a MemoryNotificationInfo object represented by cd if cd is not null; null otherwise.
- Throws:
IllegalArgumentException
- if cd does not represent a MemoryNotificationInfo object.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/11/2024 04:42:21 Cette version de la page est en cache (à la date du 22/11/2024 04:42:21) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 04/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/lang/management/MemoryNotificationInfo.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.