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 class	AgentBuilder.Default.Delegator<T extends AgentBuilder.Matchable<T>> An abstract implementation of an agent builder that delegates all invocation to another instance.
protected static class	AgentBuilder.Default.ExecutingTransformer A ClassFileTransformer that implements the enclosing agent builder's configuration.
protected class	AgentBuilder.Default.Ignoring A delegator transformer for further precising what types to ignore.
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.
protected class	AgentBuilder.Default.Transforming A helper class that describes a AgentBuilder.Default after supplying a AgentBuilder.RawMatcher such that one or several AgentBuilder.Transformers can be supplied.

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

AgentBuilder.BinaryLocator, AgentBuilder.Default, AgentBuilder.Identified, AgentBuilder.Ignored, AgentBuilder.InitializationStrategy, AgentBuilder.LambdaInstrumentationStrategy, AgentBuilder.Listener, AgentBuilder.Matchable<T extends AgentBuilder.Matchable<T>>, 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.LambdaInstrumentationStrategy lambdaInstrumentationStrategy, AgentBuilder.RawMatcher ignoredTypeMatcher, 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	disableClassFormatChanges() Disables all implicit changes on a class file that Byte Buddy would apply for certain instrumentations.
AgentBuilder	disableNativeMethodPrefix() Disables the use of a native method prefix for instrumented methods.
AgentBuilder	enableBootstrapInjection(File folder, Instrumentation instrumentation) Enables class injection of auxiliary classes into the bootstrap class loader.
AgentBuilder	enableNativeMethodPrefix(String prefix) Enables the use of the given native method prefix for instrumented methods.
boolean	equals(Object other)
int	hashCode()
AgentBuilder.Ignored	ignore(AgentBuilder.RawMatcher rawMatcher) Excludes any type that is matched by the raw matcher provided to this method.
AgentBuilder.Ignored	ignore(ElementMatcher<? super TypeDescription> ignoredTypes) Excludes any type that is matched by the provided matcher from instrumentation and considers types by all ClassLoaders.
AgentBuilder.Ignored	ignore(ElementMatcher<? super TypeDescription> ignoredTypes, ElementMatcher<? super ClassLoader> ignoredClassLoaders) Excludes any type that is matched by the provided matcher and is loaded by a class loader matching the second matcher.
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.Narrowable	type(AgentBuilder.RawMatcher matcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified.Narrowable	type(ElementMatcher<? super TypeDescription> typeMatcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified.Narrowable	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	with(AccessControlContext accessControlContext) Defines classes to be loaded using the given access control context.
AgentBuilder	with(AgentBuilder.BinaryLocator binaryLocator) Defines the use of the given binary locator for locating binary data to given class names.
AgentBuilder	with(AgentBuilder.InitializationStrategy initializationStrategy) Defines a given initialization strategy to be applied to generated types.
AgentBuilder	with(AgentBuilder.LambdaInstrumentationStrategy lambdaInstrumentationStrategy) Enables or disables management of the JVM's LambdaMetafactory which is responsible for creating classes that implement lambda expressions.
AgentBuilder	with(AgentBuilder.Listener listener) Defines the given AgentBuilder.Listener to be notified by the created agent.
AgentBuilder	with(AgentBuilder.RedefinitionStrategy redefinitionStrategy) Specifies a strategy for modifying existing types.
AgentBuilder	with(AgentBuilder.TypeStrategy typeStrategy) Defines the use of the given definition handler that determines if a type should be rebased or redefined.
AgentBuilder	with(ByteBuddy byteBuddy) Defines the given ByteBuddy instance to be used by the created agent.

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.LambdaInstrumentationStrategy lambdaInstrumentationStrategy,
                  AgentBuilder.RawMatcher ignoredTypeMatcher,
                  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.

lambdaInstrumentationStrategy - A strategy to determine of the LambdaMetfactory should be instrumented to allow for the instrumentation of classes that represent lambda expressions.

ignoredTypeMatcher - Identifies types that should not be instrumented.

transformation - The transformation object for handling type transformations.

Method Detail

with

public AgentBuilder with(ByteBuddy byteBuddy)

Description copied from interface: AgentBuilder

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

Specified by:

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

with

public AgentBuilder with(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:

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

with

public AgentBuilder with(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:

with in interface AgentBuilder

Parameters:

typeStrategy - The definition handler to use.

Returns:

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

with

public AgentBuilder with(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:

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

enableNativeMethodPrefix

public AgentBuilder enableNativeMethodPrefix(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:

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

disableNativeMethodPrefix

public AgentBuilder disableNativeMethodPrefix()

Description copied from interface: AgentBuilder

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

Specified by:

disableNativeMethodPrefix in interface AgentBuilder

Returns:

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

with

public AgentBuilder with(AccessControlContext accessControlContext)

Description copied from interface: AgentBuilder

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

Specified by:

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

with

public AgentBuilder with(AgentBuilder.RedefinitionStrategy redefinitionStrategy)

Description copied from interface: AgentBuilder

Specifies a strategy for modifying existing types.

Specified by:

with in interface AgentBuilder

Parameters:

redefinitionStrategy - The redefinition strategy to apply.

Returns:

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

with

public AgentBuilder with(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:

with in interface AgentBuilder

Parameters:

initializationStrategy - The initialization strategy to use.

Returns:

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

with

public AgentBuilder with(AgentBuilder.LambdaInstrumentationStrategy lambdaInstrumentationStrategy)

Description copied from interface: AgentBuilder

Enables or disables management of the JVM's LambdaMetafactory which is responsible for creating classes that implement lambda expressions. Without this feature enabled, classes that are represented by lambda expressions are not instrumented by the JVM such that Java agents have no effect on them when a lambda expression's class is loaded for the first time.

When activating this feature, Byte Buddy instruments the LambdaMetafactory and takes over the responsibility of creating classes that represent lambda expressions. In doing so, Byte Buddy has the opportunity to apply the built class file transformer. If the current VM does not support lambda expressions, activating this feature has no effect.

Important: If this feature is active, it is important to release the built class file transformer when deactivating it. Normally, it is sufficient to call Instrumentation.removeTransformer(ClassFileTransformer). When this feature is enabled, it is however also required to invoke AgentBuilder.LambdaInstrumentationStrategy.release(ClassFileTransformer, Instrumentation). Otherwise, the executing VMs class loader retains a reference to the class file transformer what can cause a memory leak.

Specified by:

with in interface AgentBuilder

Parameters:

lambdaInstrumentationStrategy - true if this feature should be enabled.

Returns:

A new instance of this agent builder where this feature is explicitly enabled or disabled.

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:

A new instance of this agent builder which does not apply bootstrap class loader injection.

type

public AgentBuilder.Identified.Narrowable 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. If several matchers positively match a type only the latest registered matcher is considered for transformation.

If this matcher is chained with additional subsequent matchers, this matcher is always executed first whereas the following matchers are executed in the order of their execution. If any matcher indicates that a type is to be matched, none of the following matchers is still queried.

Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation. If possible, it is also recommended, to exclude class loaders such as for example the bootstrap class loader.

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.Narrowable 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. If several matchers positively match a type only the latest registered matcher is considered for transformation.

If this matcher is chained with additional subsequent matchers, this matcher is always executed first whereas the following matchers are executed in the order of their execution. If any matcher indicates that a type is to be matched, none of the following matchers is still queried.

Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation. If possible, it is also recommended, to exclude class loaders such as for example the bootstrap class loader by using AgentBuilder.type(ElementMatcher, ElementMatcher) instead.

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.Narrowable 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. If several matchers positively match a type only the latest registered matcher is considered for transformation.

If this matcher is chained with additional subsequent matchers, this matcher is always executed first whereas the following matchers are executed in the order of their execution. If any matcher indicates that a type is to be matched, none of the following matchers is still queried.

Note: When applying a matcher, regard the performance implications by AgentBuilder.ignore(ElementMatcher). The former matcher is applied first such that it makes sense to ignore name spaces that are irrelevant to instrumentation. If possible, it is also recommended, to exclude class loaders such as for example the bootstrap class loader.

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.

ignore

public AgentBuilder.Ignored ignore(ElementMatcher<? super TypeDescription> ignoredTypes)

Description copied from interface: AgentBuilder

Excludes any type that is matched by the provided matcher from instrumentation and considers types by all ClassLoaders. By default, Byte Buddy does not instrument synthetic types and accepts all class loaders.

When ignoring a type, any subsequently chained matcher is applied after this matcher in the order of their registration. Also, if any matcher indicates that a type is to be ignored, none of the following chained matchers is executed.

Note: For performance reasons, it is recommended to always include a matcher that excludes as many namespaces as possible. Byte Buddy can determine a type's name without parsing its class file and can therefore discard such types with minimal overhead. When a different property of a type - such as for example its modifiers or its annotations is accessed - Byte Buddy parses the class file lazily in order to allow for such a matching. Therefore, any exclusion of a name should always be done as a first step and even if it does not influence the selection of what types are matched. Without changing this property, the class file of every type is being parsed!

Specified by:

ignore in interface AgentBuilder

Parameters:

ignoredTypes - A matcher that identifies types that should not be instrumented.

Returns:

A new instance of this agent builder that ignores all types that are matched by the provided matcher. All previous matchers for ignored types are discarded.

ignore

public AgentBuilder.Ignored ignore(ElementMatcher<? super TypeDescription> ignoredTypes,
                                   ElementMatcher<? super ClassLoader> ignoredClassLoaders)

Description copied from interface: AgentBuilder

Excludes any type that is matched by the provided matcher and is loaded by a class loader matching the second matcher. By default, Byte Buddy does not instrument synthetic types and accepts all class loaders.

When ignoring a type, any subsequently chained matcher is applied after this matcher in the order of their registration. Also, if any matcher indicates that a type is to be ignored, none of the following chained matchers is executed.

Note: For performance reasons, it is recommended to always include a matcher that excludes as many namespaces as possible. Byte Buddy can determine a type's name without parsing its class file and can therefore discard such types with minimal overhead. When a different property of a type - such as for example its modifiers or its annotations is accessed - Byte Buddy parses the class file lazily in order to allow for such a matching. Therefore, any exclusion of a name should always be done as a first step and even if it does not influence the selection of what types are matched. Without changing this property, the class file of every type is being parsed!

Specified by:

ignore in interface AgentBuilder

Parameters:

ignoredTypes - A matcher that identifies types that should not be instrumented.

ignoredClassLoaders - A matcher that identifies a class loader that identifies classes that should not be instrumented.

Returns:

A new instance of this agent builder that ignores all types that are matched by the provided matcher. All previous matchers for ignored types are discarded.

ignore

public AgentBuilder.Ignored ignore(AgentBuilder.RawMatcher rawMatcher)

Description copied from interface: AgentBuilder

Excludes any type that is matched by the raw matcher provided to this method. By default, Byte Buddy does not instrument synthetic types and accepts all class loaders.

When ignoring a type, any subsequently chained matcher is applied after this matcher in the order of their registration. Also, if any matcher indicates that a type is to be ignored, none of the following chained matchers is executed.

Note: For performance reasons, it is recommended to always include a matcher that excludes as many namespaces as possible. Byte Buddy can determine a type's name without parsing its class file and can therefore discard such types with minimal overhead. When a different property of a type - such as for example its modifiers or its annotations is accessed - Byte Buddy parses the class file lazily in order to allow for such a matching. Therefore, any exclusion of a name should always be done as a first step and even if it does not influence the selection of what types are matched. Without changing this property, the class file of every type is being parsed!

Specified by:

ignore in interface AgentBuilder

Parameters:

rawMatcher - A raw matcher that identifies types that should not be instrumented.

Returns:

A new instance of this agent builder that ignores all types that are matched by the provided matcher. All previous matchers for ignored types are discarded.

disableClassFormatChanges

public AgentBuilder disableClassFormatChanges()

Description copied from interface: AgentBuilder

Disables all implicit changes on a class file that Byte Buddy would apply for certain instrumentations. When using this option, it is no longer possible to rebase a method, i.e. intercepted methods are fully replaced. Furthermore, it is no longer possible to implicitly apply loaded type initializers for explicitly initializing the generated type.

This is equivalent to setting AgentBuilder.InitializationStrategy.NoOp and AgentBuilder.TypeStrategy.Default.REDEFINE_DECLARED_ONLY as well as configuring the underlying ByteBuddy instance to use a Implementation.Context.Disabled.

Specified by:

disableClassFormatChanges in interface AgentBuilder

Returns:

A new instance of this agent builder that does not apply any implicit changes to the received class file.

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