net.bytebuddy.agent.builder

Class AgentBuilder.Default

java.lang.Object

net.bytebuddy.agent.builder.AgentBuilder.Default

All Implemented Interfaces:

AgentBuilder

Enclosing interface:

AgentBuilder

public static class AgentBuilder.Default
extends Object
implements AgentBuilder

The default implementation of an AgentBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AgentBuilder.Default.BootstrapInjectionStrategy An injection strategy for injecting classes into the bootstrap class loader.
protected static class	AgentBuilder.Default.ExecutingTransformer A ClassFileTransformer that implements the enclosing agent builder's configuration.
protected class	AgentBuilder.Default.Matched A helper class that describes a AgentBuilder.Default after supplying a AgentBuilder.RawMatcher such that one or several AgentBuilder.Transformers can be supplied.
protected static interface	AgentBuilder.Default.NativeMethodStrategy A strategy for determining if a native method name prefix should be used when rebasing methods.
protected static interface	AgentBuilder.Default.Transformation A transformation serves as a handler for modifying a class.

Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder

AgentBuilder.BinaryLocator, AgentBuilder.Default, AgentBuilder.Identified, AgentBuilder.InitializationStrategy, AgentBuilder.Listener, AgentBuilder.RawMatcher, AgentBuilder.RedefinitionStrategy, AgentBuilder.Transformer, AgentBuilder.TypeStrategy

Constructor Summary

Constructors

Modifier	Constructor and Description
	Default() Creates a new default agent builder that uses a default ByteBuddy instance for creating classes.
	Default(ByteBuddy byteBuddy) Creates a new agent builder with default settings.
protected	Default(ByteBuddy byteBuddy, AgentBuilder.BinaryLocator binaryLocator, AgentBuilder.TypeStrategy typeStrategy, AgentBuilder.Listener listener, AgentBuilder.Default.NativeMethodStrategy nativeMethodStrategy, AccessControlContext accessControlContext, AgentBuilder.InitializationStrategy initializationStrategy, AgentBuilder.RedefinitionStrategy redefinitionStrategy, AgentBuilder.Default.BootstrapInjectionStrategy bootstrapInjectionStrategy, AgentBuilder.Default.Transformation transformation) Creates a new default agent builder.

Method Summary

Modifier and Type	Method and Description
AgentBuilder	disableBootstrapInjection() Disables injection of auxiliary classes into the bootstrap class path.
AgentBuilder	enableBootstrapInjection(File folder, Instrumentation instrumentation) Enables class injection of auxiliary classes into the bootstrap class loader.
boolean	equals(Object other)
int	hashCode()
ClassFileTransformer	installOn(Instrumentation instrumentation) Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with a given Instrumentation.
ClassFileTransformer	installOnByteBuddyAgent() Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.
ClassFileTransformer	makeRaw() Creates a ClassFileTransformer that implements the configuration of this agent builder.
String	toString()
AgentBuilder.Identified	type(AgentBuilder.RawMatcher matcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified	type(ElementMatcher<? super TypeDescription> typeMatcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified	type(ElementMatcher<? super TypeDescription> typeMatcher, ElementMatcher<? super ClassLoader> classLoaderMatcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder	withAccessControlContext(AccessControlContext accessControlContext) Defines classes to be loaded using the given access control context.
AgentBuilder	withBinaryLocator(AgentBuilder.BinaryLocator binaryLocator) Defines the use of the given binary locator for locating binary data to given class names.
AgentBuilder	withByteBuddy(ByteBuddy byteBuddy) Defines the given ByteBuddy instance to be used by the created agent.
AgentBuilder	withInitializationStrategy(AgentBuilder.InitializationStrategy initializationStrategy) Defines a given initialization strategy to be applied to generated types.
AgentBuilder	withListener(AgentBuilder.Listener listener) Defines the given AgentBuilder.Listener to be notified by the created agent.
AgentBuilder	withNativeMethodPrefix(String prefix) Enables the use of the given native method prefix for instrumented methods.
AgentBuilder	withoutNativeMethodPrefix() Disables the use of a native method prefix for instrumented methods.
AgentBuilder	withRedefinitionStrategy(AgentBuilder.RedefinitionStrategy redefinitionStrategy) Specifies a strategy for modifying existing types.
AgentBuilder	withTypeStrategy(AgentBuilder.TypeStrategy typeStrategy) Defines the use of the given definition handler that determines if a type should be rebased or redefined.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Default

public Default()

Creates a new default agent builder that uses a default ByteBuddy instance for creating classes.

Default

public Default(ByteBuddy byteBuddy)

Creates a new agent builder with default settings.

Parameters:

byteBuddy - The Byte Buddy instance to be used.

Default

protected Default(ByteBuddy byteBuddy,
                  AgentBuilder.BinaryLocator binaryLocator,
                  AgentBuilder.TypeStrategy typeStrategy,
                  AgentBuilder.Listener listener,
                  AgentBuilder.Default.NativeMethodStrategy nativeMethodStrategy,
                  AccessControlContext accessControlContext,
                  AgentBuilder.InitializationStrategy initializationStrategy,
                  AgentBuilder.RedefinitionStrategy redefinitionStrategy,
                  AgentBuilder.Default.BootstrapInjectionStrategy bootstrapInjectionStrategy,
                  AgentBuilder.Default.Transformation transformation)

Creates a new default agent builder.

Parameters:

byteBuddy - The Byte Buddy instance to be used.

binaryLocator - The binary locator to use.

typeStrategy - The definition handler to use.

listener - The listener to notify on transformations.

nativeMethodStrategy - The native method strategy to apply.

accessControlContext - The access control context to use for loading classes.

initializationStrategy - The initialization strategy to use for transformed types.

redefinitionStrategy - The redefinition strategy to apply.

bootstrapInjectionStrategy - The injection strategy for injecting classes into the bootstrap class loader.

transformation - The transformation object for handling type transformations.

Method Detail

type

public AgentBuilder.Identified type(AgentBuilder.RawMatcher matcher)

Description copied from interface: AgentBuilder

Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.

Specified by:

type in interface AgentBuilder

Parameters:

matcher - A matcher that decides if the entailed AgentBuilder.Transformers should be applied for a type that is being loaded.

Returns:

A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when the given matcher indicates a match.

type

public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher)

Description copied from interface: AgentBuilder

Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.

Specified by:

type in interface AgentBuilder

Parameters:

typeMatcher - An ElementMatcher that is applied on the type being loaded that decides if the entailed AgentBuilder.Transformers should be applied for that type.

Returns:

A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when the given typeMatcher indicates a match.

type

public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher,
                                    ElementMatcher<? super ClassLoader> classLoaderMatcher)

Description copied from interface: AgentBuilder

Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.

Specified by:

type in interface AgentBuilder

Parameters:

typeMatcher - An ElementMatcher that is applied on the type being loaded that decides if the entailed AgentBuilder.Transformers should be applied for that type.

classLoaderMatcher - An ElementMatcher that is applied to the ClassLoader that is loading the type being loaded. This matcher is always applied first where the type matcher is not applied in case that this matcher does not indicate a match.

Returns:

A definable that represents this agent builder which allows for the definition of one or several AgentBuilder.Transformers to be applied when both the given typeMatcher and classLoaderMatcher indicate a match.

withByteBuddy

public AgentBuilder withByteBuddy(ByteBuddy byteBuddy)

Description copied from interface: AgentBuilder

Defines the given ByteBuddy instance to be used by the created agent.

Specified by:

withByteBuddy in interface AgentBuilder

Parameters:

byteBuddy - The Byte Buddy instance to be used.

Returns:

A new instance of this agent builder which makes use of the given byteBuddy instance.

withListener

public AgentBuilder withListener(AgentBuilder.Listener listener)

Description copied from interface: AgentBuilder

Defines the given AgentBuilder.Listener to be notified by the created agent. The given listener is notified after any other listener that is already registered. If a listener is registered twice, it is also notified twice.

Specified by:

withListener in interface AgentBuilder

Parameters:

listener - The listener to be notified.

Returns:

A new instance of this agent builder which creates an agent that informs the given listener about events.

withTypeStrategy

public AgentBuilder withTypeStrategy(AgentBuilder.TypeStrategy typeStrategy)

Description copied from interface: AgentBuilder

Defines the use of the given definition handler that determines if a type should be rebased or redefined.

Specified by:

withTypeStrategy in interface AgentBuilder

Parameters:

typeStrategy - The definition handler to use.

Returns:

A new instance of this agent builder which uses the given definition handler.

withBinaryLocator

public AgentBuilder withBinaryLocator(AgentBuilder.BinaryLocator binaryLocator)

Description copied from interface: AgentBuilder

Defines the use of the given binary locator for locating binary data to given class names.

Specified by:

withBinaryLocator in interface AgentBuilder

Parameters:

binaryLocator - The binary locator to use.

Returns:

A new instance of this agent builder which uses the given binary locator for looking up class files.

withNativeMethodPrefix

public AgentBuilder withNativeMethodPrefix(String prefix)

Description copied from interface: AgentBuilder

Enables the use of the given native method prefix for instrumented methods. Note that this prefix is also applied when preserving non-native methods. The use of this prefix is also registered when installing the final agent with an Instrumentation.

Specified by:

withNativeMethodPrefix in interface AgentBuilder

Parameters:

prefix - The prefix to be used.

Returns:

A new instance of this agent builder which uses the given native method prefix.

withoutNativeMethodPrefix

public AgentBuilder withoutNativeMethodPrefix()

Description copied from interface: AgentBuilder

Disables the use of a native method prefix for instrumented methods.

Specified by:

withoutNativeMethodPrefix in interface AgentBuilder

Returns:

A new instance of this agent builder which does not use a native method prefix.

withAccessControlContext

public AgentBuilder withAccessControlContext(AccessControlContext accessControlContext)

Description copied from interface: AgentBuilder

Defines classes to be loaded using the given access control context.

Specified by:

withAccessControlContext in interface AgentBuilder

Parameters:

accessControlContext - The access control context to be used for loading classes.

Returns:

A new instance of this agent builder which uses the given access control context for class loading.

withRedefinitionStrategy

public AgentBuilder withRedefinitionStrategy(AgentBuilder.RedefinitionStrategy redefinitionStrategy)

Description copied from interface: AgentBuilder

Specifies a strategy for modifying existing types.

Specified by:

withRedefinitionStrategy in interface AgentBuilder

Parameters:

redefinitionStrategy - The redefinition strategy to apply.

Returns:

A new instance of this agent builder that applies the given redefinition strategy.

withInitializationStrategy

public AgentBuilder withInitializationStrategy(AgentBuilder.InitializationStrategy initializationStrategy)

Description copied from interface: AgentBuilder

Defines a given initialization strategy to be applied to generated types. An initialization strategy is responsible for setting up a type after it was loaded. This initialization must be performed after the transformation because a Java agent is only invoked before loading a type. By default, the initialization logic is added to a class's type initializer which queries a global object for any objects that are to be injected into the generated type.

Specified by:

withInitializationStrategy in interface AgentBuilder

Parameters:

initializationStrategy - The initialization strategy to use.

Returns:

A new instance of this agent builder that applies the given initialization strategy.

enableBootstrapInjection

public AgentBuilder enableBootstrapInjection(File folder,
                                             Instrumentation instrumentation)

Description copied from interface: AgentBuilder

Enables class injection of auxiliary classes into the bootstrap class loader.

Specified by:

enableBootstrapInjection in interface AgentBuilder

Parameters:

folder - The folder in which jar files of the injected classes are to be stored.

instrumentation - The instrumentation instance that is used for appending jar files to the bootstrap class path.

Returns:

An agent builder with bootstrap class loader class injection enabled.

disableBootstrapInjection

public AgentBuilder disableBootstrapInjection()

Description copied from interface: AgentBuilder

Disables injection of auxiliary classes into the bootstrap class path.

Specified by:

disableBootstrapInjection in interface AgentBuilder

Returns:

An agent builder with bootstrap class loader class injection disbaled.

makeRaw

public ClassFileTransformer makeRaw()

Description copied from interface: AgentBuilder

Creates a ClassFileTransformer that implements the configuration of this agent builder.

Specified by:

makeRaw in interface AgentBuilder

Returns:

A class file transformer that implements the configuration of this agent builder.

installOn

public ClassFileTransformer installOn(Instrumentation instrumentation)

Description copied from interface: AgentBuilder

Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with a given Instrumentation. If retransformation is enabled, the installation also causes all loaded types to be retransformed.

Specified by:

installOn in interface AgentBuilder

Parameters:

instrumentation - The instrumentation on which this agent builder's configuration is to be installed.

Returns:

The installed class file transformer.

installOnByteBuddyAgent

public ClassFileTransformer installOnByteBuddyAgent()

Description copied from interface: AgentBuilder

Creates and installs a ClassFileTransformer that implements the configuration of this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.

Specified by:

installOnByteBuddyAgent in interface AgentBuilder

Returns:

The installed class file transformer.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object