Class AgentInitializationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.tools.attach.AgentInitializationException

All Implemented Interfaces:

Serializable

public class AgentInitializationException
extends Exception

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.

Since:

1.6

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AgentInitializationException()	Constructs an AgentInitializationException with no detail message.
AgentInitializationException(String s)	Constructs an AgentInitializationException with the specified detail message.
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.

Method Summary

Modifier and Type	Method	Description
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.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Modifier and Type	Method	Description
final void	addSuppressed(Throwable exception)	The specified exception is going to be suppressed in order to give priority to this exception (primary exception) and to be appended to the list of suppressed exceptions.
Throwable	fillInStackTrace()	Record in the receiver a walkback from the point where this message was sent.
Throwable	getCause()	Answers the cause of this Throwable, or null if there is no cause.
String	getLocalizedMessage()	Answers the extra information message which was provided when the throwable was created.
String	getMessage()	Answers the extra information message which was provided when the throwable was created.
StackTraceElement[]	getStackTrace()	Answers an array of StackTraceElement.
final Throwable[]	getSuppressed()	Returns an array of exceptions suppressed, typically by the automatically generated code from the try-with-resources statement, in order to give priority to this exception (primary exception).
Throwable	initCause(Throwable throwable)	Initialize the cause of the receiver.
void	printStackTrace()	Outputs a printable representation of the receiver's walkback on the System.err stream.
void	printStackTrace(PrintStream err)	Outputs a printable representation of the receiver's walkback on the stream specified by the argument.
void	printStackTrace(PrintWriter err)	Outputs a printable representation of the receiver's walkback on the writer specified by the argument.
void	setStackTrace(StackTraceElement[] trace)	Sets the array of StackTraceElements.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

AgentInitializationException

public AgentInitializationException()

Constructs an AgentInitializationException with no detail message.

AgentInitializationException

public AgentInitializationException(String s)

Constructs an AgentInitializationException with the specified detail message.

Parameters:

s - the detail message.

AgentInitializationException

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 - the detail message.

returnValue - the return value

Method Details

returnValue

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:

the return value