Класс VirtualMachine

protected VirtualMachine(AttachProvider provider, String id)

Инициализирует новый экземпляр этого класса.

public static List<VirtualMachineDescriptor> list()

Возвращает список виртуальных машин Java.

Этот метод возвращает список элементов Java VirtualMachineDescriptor. Список представляет собой агрегацию списков описателей виртуальных машин, полученных путем вызова метода listVirtualMachines всех установленных attach providers. Если никакими поставщиками не известны виртуальные машины Java, возвращается пустой список.

public static VirtualMachine attach(String id) throws AttachNotSupportedException, IOException

Подключается к виртуальной машине Java.

Этот метод получает список поставщиков подключений, вызывая метод AttachProvider.providers(). Затем он перебирает список и поочередно вызывает метод attachVirtualMachine каждого поставщика. Если поставщик успешно подключается, итерация завершается, а созданная поставщиком, который успешно подключился, VirtualMachine возвращается этим методом. Если метод attachVirtualMachine всех поставщиков выбрасывает исключение AttachNotSupportedException, то этот метод также выбрасывает AttachNotSupportedException. Это означает, что AttachNotSupportedException выбрасывается, когда предоставленный этому методу идентификатор недействителен, или идентификатор соответствует виртуальной машине Java, которая не существует, или ни один из поставщиков не может подключиться к ней. Это исключение также выбрасывается, если AttachProvider.providers() возвращает пустой список.

public static VirtualMachine attach(VirtualMachineDescriptor vmd) throws AttachNotSupportedException, IOException

Подключается к виртуальной машине Java.

Этот метод сначала вызывает метод provider() заданного описателя виртуальной машины для получения поставщика подключения. Затем он вызывает метод attachVirtualMachine поставщика подключения, чтобы подключиться к целевой VM.

public abstract void detach() throws IOException

Отсоединение от виртуальной машины.

После отсоединения от виртуальной машины любая дальнейшая попытка вызвать операции на этой виртуальной машине приведет к тому, что будет брошено исключение IOException. Если операция (например, loadAgent) выполняется в момент вызова этого метода, поведение зависит от реализации. Другими словами, от того, завершится операция или будет выброшено IOException, зависит от реализации.

Если от виртуальной машины уже отсоединено, вызов этого метода не повлияет на работу.

public final AttachProvider provider()

Возвращает поставщика, который создал эту виртуальную машину.

public final String id()

Возвращает идентификатор этой виртуальной машины Java.

public abstract void loadAgentLibrary(String agentLibrary, String options) throws AgentLoadException, AgentInitializationException, IOException

Загрузка агента библиотеки.

Клиент JVM TI называется агентом. Он разработан на родном языке. Агент JVM TI развертывается платформоспецифичным образом, но обычно это платформенный эквивалент динамической библиотеки. В качестве альтернативы, он может быть статически связан с VM. Этот метод вызывает загрузку указанной библиотеки агента в целевую VM (если она еще не загружена или если она не статически связана с VM). Затем он вызывает функцию Agent_OnAttach целевой VM или функцию Agent_OnAttach_L для статически связанного агента под именем 'L', как указано в спецификации JVM Tools Interface. Обратите внимание, что функция Agent_OnAttach[_L] вызывается даже если библиотека агента была загружена до вызова этого метода.

Предоставляемая библиотека агента — это имя библиотеки агента. Оно интерпретируется целевой виртуальной машиной по зависимости от реализации. Обычно реализация преобразует имя библиотеки в имя файла, специфичное для операционной системы. Например, в системах UNIX имя L может быть преобразовано в libL.so, и найдено, используя путь поиска, заданный переменной среды LD_LIBRARY_PATH. Если агент под именем 'L' статически связан с VM, то VM должна экспортировать функцию под именем Agent_OnAttach_L.

Если функция Agent_OnAttach[_L] в библиотеке агента возвращает ошибку, то выбрасывается исключение AgentInitializationException. Значение возврата из Agent_OnAttach[_L] можно получить, вызвав метод returnValue на исключении.

public void loadAgentLibrary(String agentLibrary) throws AgentLoadException, AgentInitializationException, IOException

Загрузка библиотеки агента.

Этот метод-удобство работает так, как будто вызывается:

loadAgentLibrary(agentLibrary, null);

public abstract void loadAgentPath(String agentPath, String options) throws AgentLoadException, AgentInitializationException, IOException

Загрузка библиотеки нативного агента по полному пути.

Клиент JVM TI называется агентом. Он разработан на родном языке. Агент JVM TI развертывается специфичным для платформы способом, но обычно является платформенным эквивалентом динамической библиотеки. В качестве альтернативы, нативная библиотека, указанная параметром agentPath, может быть статически связана с виртуальной машиной. Разбор параметра agentPath в имя статически связанной библиотеки выполняется специфичным для платформы способом в виртуальной машине. Например, в UNIX параметр agentPath /a/b/libL.so будет называть библиотеку 'L'. Более подробные сведения см. в спецификации JVM TI. Этот метод вызывает загрузку указанной библиотеки агента в целевую виртуальную машину (если она ещё не загружена или не статически связана с виртуальной машиной). Затем он заставляет целевую виртуальную машину вызвать функцию Agent_OnAttach или, для статически связанного агента с именем 'L', функцию Agent_OnAttach_L, как указано в спецификации интерфейса инструментов JVM. Обратите внимание, что функция Agent_OnAttach[_L] вызывается даже если библиотека агента была загружена до вызова этого метода.

Предоставляемая библиотека агента — это абсолютный путь, с которого нужно загрузить библиотеку агента. В отличие от loadAgentLibrary, имя библиотеки не расширяется в целевой виртуальной машине.

Если функция Agent_OnAttach[_L] в библиотеке агента возвращает ошибку, то генерируется исключение AgentInitializationException. Значение, возвращённое Agent_OnAttach[_L], можно получить, вызвав метод returnValue в исключении.

public void loadAgentPath(String agentPath) throws AgentLoadException, AgentInitializationException, IOException

Загрузка библиотеки нативного агента по полному пути.

Этот метод-удобство работает так, как если бы вызывали:

loadAgentPath(agentLibrary, null);

public abstract void loadAgent(String agent, String options) throws AgentLoadException, AgentInitializationException, IOException

Загрузка агента.

Агент, предоставленный этому методу, — это имя пути к файлу JAR в файловой системе целевой виртуальной машины. Этот путь передаётся целевой виртуальной машине, где он интерпретируется. Целевая виртуальная машина пытается запустить агент, как указано в спецификации java.lang.instrument. То есть, указанный файл JAR добавляется в системный путь класса (целевой виртуальной машины), и вызывается метод agentmain класса агента, указанный атрибутом Agent-Class в манифесте JAR. Этот метод завершается, когда завершается метод agentmain.

public void loadAgent(String agent) throws AgentLoadException, AgentInitializationException, IOException

Загрузка агента.

Этот метод-удобство работает так, как если бы вызывали:

loadAgent(agent, null);

public abstract Properties getSystemProperties() throws IOException

Возвращает текущие системные свойства в целевой виртуальной машине.

Этот метод возвращает системные свойства в целевой виртуальной машине. Свойства, у которых ключ или значение не являются String, опускаются. Метод примерно эквивалентен вызову метода System.getProperties в целевой виртуальной машине, за исключением того, что свойства с ключом или значением, которые не являются String, не включаются.

Этот метод обычно используется для определения агента, который нужно загрузить в целевую виртуальную машину с помощью loadAgent или loadAgentLibrary. Например, свойства java.home или user.dir могут использоваться для создания пути к библиотеке агента или файлу JAR.

public abstract Properties getAgentProperties() throws IOException

Возвращает текущие свойства агента в целевой виртуальной машине.

Целевая виртуальная машина может поддерживать список свойств от имени агентов. Способ, имена свойств и допустимые типы значений зависят от реализации. Свойства агента обычно используются для хранения точек подключения, и других данных конфигурации агента. Например, агент отладчика может создать свойство агента для адреса своего транспорта.

Этот метод возвращает свойства агента, у которых ключ и значение являются String. Свойства, у которых ключ или значение не являются String, опускаются. Если в целевой виртуальной машине не сохраняются свойства агента, возвращается пустой список свойств.

public abstract void startManagementAgent(Properties agentProperties) throws IOException

Запуск агента управления JMX в целевой виртуальной машине.

Свойства конфигурации такие же, как те, которые задаются в командной строке при запуске агента управления JMX. Так же как и в командной строке, необходимо указать, по крайней мере, свойство com.sun.management.jmxremote.port.

Более подробные сведения см. в онлайн-документации по Мониторинг и управление с помощью технологии JMX.

public abstract String startLocalManagementAgent() throws IOException

Запускает локальный агент управления JMX в целевой виртуальной машине.

См. онлайн-документацию по Мониторингу и управлению с использованием технологии JMX для получения дополнительных сведений.

public int hashCode()

Возвращает значение хеш-кода для этой VirtualMachine. Хеш-код основан на компонентах VirtualMachine и удовлетворяет общему контракту метода Object.hashCode.

public boolean equals(Object ob)

Проверяет это VirtualMachine на равенство с другим объектом.

Если данный объект не является VirtualMachine, то этот метод возвращает false. Для того, чтобы две VirtualMachine считались равными, необходимо, чтобы они оба ссылались на один и тот же поставщик, и их identifiers были равны.

Этот метод удовлетворяет общему контракту метода Object.equals.

public String toString()

Возвращает строковое представление VirtualMachine.