Class Installer

java.lang.Object
net.bytebuddy.agent.Installer
public class Installer extends Object
An installer class which defined the hook-in methods that are required by the Java agent specification.

  • Field Details

    • NAME

      public static final String NAME
      The name of the Installer class that is stored in an obfuscated format which will not be relocated.

    • instrumentation

      @MaybeNull private static volatile Instrumentation instrumentation
      A field for carrying the Instrumentation that was loaded by the Byte Buddy agent. Note that this field must never be accessed directly as the agent is injected into the VM's system class loader. This way, the field of this class might be null even after the installation of the Byte Buddy agent as this class might be loaded by a different class loader than the system class loader.

  • Constructor Details

    • Installer

      private Installer()
      The installer provides only static hook-in methods and should not be instantiated.

  • Method Details

    • getInstrumentation

      public static Instrumentation getInstrumentation()

      Returns the instrumentation that was loaded by the Byte Buddy agent. When a security manager is active, the RuntimePermission for getInstrumentation is required by the caller.

      Important: This method must only be invoked via the ClassLoader.getSystemClassLoader() where any Java agent is loaded. It is possible that two versions of this class exist for different class loaders.

      Returns:
      The instrumentation instance of the Byte Buddy agent.

    • premain

      public static void premain(String arguments, Instrumentation instrumentation)
      Allows the installation of this agent via a command line argument.
      Parameters:
      arguments - The unused agent arguments.
      instrumentation - The instrumentation instance.

    • agentmain

      public static void agentmain(String arguments, Instrumentation instrumentation)
      Allows the installation of this agent via the attach API.
      Parameters:
      arguments - The unused agent arguments.
      instrumentation - The instrumentation instance.

    • doMain

      private static void doMain(Instrumentation instrumentation)
      Installs the Instrumentation in the current class and possibly obfuscated class.
      Parameters:
      instrumentation - The instrumentation instance.