Spec-Zone.ru › OpenJDK 24

Интерфейс HotSpotDiagnosticMXBean

Все суперинтерфейсы:
PlatformManagedObject
public interface HotSpotDiagnosticMXBean extends PlatformManagedObject
Интерфейс управления диагностикой для виртуальной машины HotSpot.

MBean для диагностики регистрируется в сервере MBean платформы, как и другие платформенные MBean.

Идентификатор ObjectName для уникальной идентификации MBean для диагностики в пределах сервера MBean:

com.sun.management:type=HotSpotDiagnostic
Его можно получить, вызвав метод PlatformManagedObject.getObjectName(). Все методы выбрасывают исключение NullPointerException, если какой-либо аргумент является null, если не указано иное.
С:
1.6
См. также:
  • ManagementFactory.getPlatformMXBeans(Class)

Краткое описание вложенных классов

Модификатор и тип Интерфейс Описание
static enum  HotSpotDiagnosticMXBean.ThreadDumpFormat
Формат дампа потоков.

Краткое описание методов

Модификатор и тип Метод Описание
void dumpHeap(String outputFile, boolean live)
Выгружает кучу в файл outputFile в том же формате, что и дамп кучи hprof.
default void dumpThreads(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format)
Генерирует дамп потоков в указанный файл в заданном формате.
List<VMOption> getDiagnosticOptions()
Возвращает список объектов VMOption для всех диагностических параметров.
VMOption getVMOption(String name)
Возвращает объект VMOption для параметра VM с заданным именем.
void setVMOption(String name, String value)
Устанавливает параметр VM с заданным именем в указанное значение.

Методы, объявленные в интерфейсе java.lang.management.PlatformManagedObject

getObjectName

Подробное описание методов

dumpHeap

void dumpHeap(String outputFile, boolean live) throws IOException
Выгружает кучу в файл outputFile в том же формате, что и дамп кучи hprof.

Если этот метод вызывается удаленно из другого процесса, вывод дампа кучи записывается в файл с именем outputFile на машине, где запущена целевая виртуальная машина. Если outputFile является относительным путем, он является относительным к рабочей директории, в которой была запущена целевая виртуальная машина.

Параметры:
outputFile - имя файла, зависящее от операционной системы
live - если true выгружается только живые объекты, то есть объекты, доступные из других объектов
Исключения:
IOException - если файл outputFile уже существует, не может быть создан, открыт или записан.
UnsupportedOperationException - если операция не поддерживается.
IllegalArgumentException - если outputFile не заканчивается на ".hprof".
NullPointerException - если outputFile является null.

getDiagnosticOptions

List<VMOption> getDiagnosticOptions()
Возвращает список объектов VMOption для всех диагностических параметров. Диагностический параметр — это параметр VM, writeable который может быть изменён динамически, в основном для устранения неполадок и диагностики.
Возвращает:
список объектов VMOption для всех диагностических параметров.

getVMOption

VMOption getVMOption(String name)
Возвращает объект VMOption для параметра VM с заданным именем.
Возвращает:
объект VMOption для параметра VM с заданным именем.
Исключения:
NullPointerException - если имя является null.
IllegalArgumentException - если параметр VM с заданным именем не существует.

setVMOption

void setVMOption(String name, String value)
Устанавливает параметр VM с заданным именем в указанное значение. Новое значение будет отражено в новом объекте VMOption, возвращаемом методом getVMOption(java.lang.String) или методом getDiagnosticOptions(). Этот метод не изменяет значение этого объекта VMOption.
Параметры:
name - Имя параметра VM
value - Новое значение параметра VM
Исключения:
IllegalArgumentException - если параметр VM с заданным именем не существует.
IllegalArgumentException - если новое значение некорректно.
IllegalArgumentException - если параметр VM не является изменяемым.
NullPointerException - если имя или значение являются null.

dumpThreads

default void dumpThreads(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format) throws IOException
Генерирует дамп потоков в указанный файл в заданном формате. Параметр outputFile должен быть абсолютным путем к файлу, который не существует.

Дамп потоков будет содержать вывод для всех потоков платформы. Он может содержать вывод для некоторых или всех виртуальных потоков.

Примечание API:
Файл вывода должен быть абсолютным путем, так как к MXBean может быть удаленно обращён инструмент или программа с другой текущей рабочей директорией.
Требования к реализации:
По умолчанию реализация выбрасывает UnsupportedOperationException.
Параметры:
outputFile - путь к создаваемому файлу
format - формат для использования
Исключения:
IllegalArgumentException - если путь к файлу не является абсолютным
IOException - если файл уже существует или при записи во время выполнения возникает ошибка ввода-вывода
NullPointerException - если какой-либо параметр имеет значение null
UnsupportedOperationException - если операция не поддерживается
С:
21

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/jdk.management/com/sun/management/HotSpotDiagnosticMXBean.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API