Class AgentInitializationException

  • All Implemented Interfaces:
    java.io.Serializable

    public final class AgentInitializationException
    extends java.lang.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.

    See Also:
    Serialized Form
    • Constructor Summary

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

      All Methods Instance Methods Concrete Methods 
      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 inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • returnValue

        private final int returnValue
    • Constructor Detail

      • AgentInitializationException

        public AgentInitializationException()
        Constructs an AgentInitializationException with no detail message.
      • AgentInitializationException

        public AgentInitializationException​(java.lang.String s)
        Constructs an AgentInitializationException with the specified detail message.
        Parameters:
        s - the detail message.
      • AgentInitializationException

        public AgentInitializationException​(java.lang.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 Detail

      • 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.