com.sun.tools.attach (Java SE 17 & JDK 17)
Description: declaration: module: jdk.attach, package: com.sun.tools.attach
Keywords: com.sun.tools.attach package

Module jdk.attach

# Package com.sun.tools.attach

package com.sun.tools.attach
Provides the API to attach to a Java virtual machine.

A tool, written in the Java Language, uses this API to attach to a target virtual machine (VM) and load its tool agent into the target VM. For example, a management console might have a management agent which it uses to obtain management information from instrumented objects in a Java virtual machine. If the management console is required to manage an application that is running in a virtual machine that does not include the management agent, then this API can be used to attach to the target VM and load the agent.

Since:
  1.6

- Related Packages
  Package
  Description
  com.sun.tools.attach.spi
  Only developers who are defining new attach providers should need to make direct use of this package.
- Class
  Description
  AgentInitializationException
  The exception thrown when an agent fails to initialize in the target Java virtual machine.
  AgentLoadException
  The exception thrown when an agent cannot be loaded into the target Java virtual machine.
  AttachNotSupportedException
  Thrown by `VirtualMachine.attach` when attempting to attach to a Java virtual machine for which a compatible `AttachProvider` does not exist.
  AttachOperationFailedException
  Exception type to signal that an attach operation failed in the target VM.
  AttachPermission
  When a `SecurityManager` set, this is the permission which will be checked when code invokes `VirtualMachine.attach` to attach to a target virtual machine.
  VirtualMachine
  A Java virtual machine.
  VirtualMachineDescriptor
  Describes a Java virtual machine.