net.bytebuddy.dynamic

Class ClassFileLocator.AgentBased

java.lang.Object

net.bytebuddy.dynamic.ClassFileLocator.AgentBased

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ClassFileLocator

Enclosing interface:

ClassFileLocator

@HashCodeAndEqualsPlugin.Enhance
public static class ClassFileLocator.AgentBased
extends java.lang.Object
implements ClassFileLocator

A Java agent that allows the location of class files by emulating a retransformation. Note that this class file locator causes a class to be loaded in order to look up its class file. Also, this locator does deliberately not support the look-up of classes that represent lambda expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClassFileLocator.AgentBased.ClassLoadingDelegate A delegate that is queried for loading a class.
protected static interface	ClassFileLocator.AgentBased.Dispatcher A dispatcher to interact with the Instrumentation API.
protected static class	ClassFileLocator.AgentBased.ExtractionClassFileTransformer A non-operational class file transformer that remembers the binary format of a given class.

Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.ClassFileLocator

ClassFileLocator.AgentBased, ClassFileLocator.Compound, ClassFileLocator.ForClassLoader, ClassFileLocator.ForFolder, ClassFileLocator.ForJarFile, ClassFileLocator.ForModule, ClassFileLocator.ForModuleFile, ClassFileLocator.ForUrl, ClassFileLocator.NoOp, ClassFileLocator.PackageDiscriminating, ClassFileLocator.Resolution, ClassFileLocator.Simple

Field Summary

Fields

Modifier and Type	Field and Description
private ClassFileLocator.AgentBased.ClassLoadingDelegate	classLoadingDelegate The delegate to load a class by its name.
private static ClassFileLocator.AgentBased.Dispatcher	DISPATCHER A dispatcher for interacting with the instrumentation API.
private static java.lang.String	INSTALLER_TYPE The name of the Byte Buddy net.bytebuddy.agent.Installer class.
private java.lang.instrument.Instrumentation	instrumentation The instrumentation instance to use for looking up the binary format of a type.
private static java.lang.String	INSTRUMENTATION_GETTER The name of the net.bytebuddy.agent.Installer getter for reading an installed Instrumentation.
private static java.lang.Object	STATIC_MEMBER Indicator for access to a static member via reflection to make the code more readable.

Fields inherited from interface net.bytebuddy.dynamic.ClassFileLocator

CLASS_FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
AgentBased(java.lang.instrument.Instrumentation instrumentation, ClassFileLocator.AgentBased.ClassLoadingDelegate classLoadingDelegate) Creates an agent-based class file locator.
AgentBased(java.lang.instrument.Instrumentation instrumentation, java.lang.ClassLoader classLoader) Creates an agent-based class file locator.

Method Summary

Modifier and Type	Method and Description
void	close()
static ClassFileLocator	fromInstalledAgent(java.lang.ClassLoader classLoader) Returns an agent-based class file locator for the given class loader and an already installed Byte Buddy-agent.
ClassFileLocator.Resolution	locate(java.lang.String name) Locates the class file for a given type and returns the binary data of the class file.
static ClassFileLocator	of(java.lang.instrument.Instrumentation instrumentation, java.lang.Class<?> type) Returns a class file locator that is capable of locating a class file for the given type using the given instrumentation instance.

Methods inherited from class java.lang.Object

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

Field Detail

INSTALLER_TYPE

private static final java.lang.String INSTALLER_TYPE

The name of the Byte Buddy net.bytebuddy.agent.Installer class.

See Also:

Constant Field Values

INSTRUMENTATION_GETTER

private static final java.lang.String INSTRUMENTATION_GETTER

The name of the net.bytebuddy.agent.Installer getter for reading an installed Instrumentation.

See Also:

Constant Field Values

STATIC_MEMBER

private static final java.lang.Object STATIC_MEMBER

Indicator for access to a static member via reflection to make the code more readable.

DISPATCHER

private static final ClassFileLocator.AgentBased.Dispatcher DISPATCHER

A dispatcher for interacting with the instrumentation API.

instrumentation

private final java.lang.instrument.Instrumentation instrumentation

The instrumentation instance to use for looking up the binary format of a type.

classLoadingDelegate

private final ClassFileLocator.AgentBased.ClassLoadingDelegate classLoadingDelegate

The delegate to load a class by its name.

Constructor Detail

AgentBased

public AgentBased(java.lang.instrument.Instrumentation instrumentation,
                  java.lang.ClassLoader classLoader)

Creates an agent-based class file locator.

Parameters:

instrumentation - The instrumentation to be used.

classLoader - The class loader to read a class from.

AgentBased

public AgentBased(java.lang.instrument.Instrumentation instrumentation,
                  ClassFileLocator.AgentBased.ClassLoadingDelegate classLoadingDelegate)

Creates an agent-based class file locator.

Parameters:

instrumentation - The instrumentation to be used.

classLoadingDelegate - The delegate responsible for class loading.

Method Detail

fromInstalledAgent

public static ClassFileLocator fromInstalledAgent(java.lang.ClassLoader classLoader)

Returns an agent-based class file locator for the given class loader and an already installed Byte Buddy-agent.

Parameters:

classLoader - The class loader that is expected to load the looked-up a class.

Returns:

A class file locator for the given class loader based on a Byte Buddy agent.

of

public static ClassFileLocator of(java.lang.instrument.Instrumentation instrumentation,
                                  java.lang.Class<?> type)

Returns a class file locator that is capable of locating a class file for the given type using the given instrumentation instance.

Parameters:

instrumentation - The instrumentation instance to query for a retransformation.

type - The locatable type which class loader is used as a fallback.

Returns:

A class file locator for locating the class file of the given type.

locate

public ClassFileLocator.Resolution locate(java.lang.String name)

Locates the class file for a given type and returns the binary data of the class file.

Specified by:

locate in interface ClassFileLocator

Parameters:

name - The name of the type to locate a class file representation for.

Returns:

Any binary representation of the type which might be illegal.

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable