OpenJDK 27 · com.sun.tools.attach.AgentInitializationException

The exception thrown when an agent fails to initialize in the target Java virtual machine.

This exception is thrown by VirtualMachine.loadAgent, VirtualMachine.loadAgentLibrary, VirtualMachine.loadAgentPath methods if an agent, or agent library, cannot be initialized. When thrown by VirtualMachine.loadAgentLibrary, or VirtualMachine.loadAgentPath then the exception encapsulates the error returned by the agent's Agent_OnAttach function. This error code can be obtained by invoking the returnValue method.

Field Summary

Modifier and Type	Field and Description
private int	returnValue
pack-priv static final long	serialVersionUID Hides java.lang.Exception.serialVersionUID. use serialVersionUID for interoperability

Constructor Summary

Access	Constructor and Description
public	AgentInitializationException() Constructs an `AgentInitializationException` with no detail message.
public	AgentInitializationException(String the detail message. s) Constructs an `AgentInitializationException` with the specified detail message.
public	AgentInitializationException(String the detail message. s, int the return value returnValue) Constructs an `AgentInitializationException` with the specified detail message and the return value from the execution of the agent's `Agent_OnAttach` function.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the return value returnValue() If the exception was created with the return value from the agent `Agent_OnAttach` function then this returns that value, otherwise returns `0`.

Field Detail

returnValue	back to summary
private int returnValue

serialVersionUID	back to summary
pack-priv static final long serialVersionUID Hides java.lang.Exception.serialVersionUID. use serialVersionUID for interoperability

serialVersionUID

back to summary

pack-priv static final long serialVersionUID

Hides java.lang.Exception.serialVersionUID.

use serialVersionUID for interoperability

Constructor Detail

AgentInitializationException	back to summary
public AgentInitializationException() Constructs an `AgentInitializationException` with no detail message.

AgentInitializationException back to summary

AgentInitializationException	back to summary
public AgentInitializationException(String s) Constructs an `AgentInitializationException` with the specified detail message. Parameters s:String the detail message.

public AgentInitializationException(String s)

Constructs an AgentInitializationException with the specified detail message.

Parameters

s:String: the detail message.

AgentInitializationException back to summary

AgentInitializationException	back to summary
public AgentInitializationException(String s, int returnValue) Constructs an `AgentInitializationException` with the specified detail message and the return value from the execution of the agent's `Agent_OnAttach` function. Parameters s:String the detail message. returnValue:int the return value

public AgentInitializationException(String s, int returnValue)

Constructs an AgentInitializationException with the specified detail message and the return value from the execution of the agent's Agent_OnAttach function.

Parameters

s:String: the detail message.
returnValue:int: the return value

Method Detail

returnValue back to summary

returnValue	back to summary
public int returnValue() If the exception was created with the return value from the agent `Agent_OnAttach` function then this returns that value, otherwise returns `0`. Returns:int the return value

public int returnValue()

If the exception was created with the return value from the agent Agent_OnAttach function then this returns that value, otherwise returns 0.