public static class AgentBuilder.Default extends Object implements AgentBuilder
AgentBuilder
.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.Transformer s 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.
|
AgentBuilder.BinaryLocator, AgentBuilder.Default, AgentBuilder.Identified, AgentBuilder.InitializationStrategy, AgentBuilder.LambdaInstrumentationStrategy, AgentBuilder.Listener, AgentBuilder.RawMatcher, AgentBuilder.RedefinitionStrategy, AgentBuilder.Transformer, AgentBuilder.TypeStrategy
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,
ElementMatcher<? super TypeDescription> ignoredTypes,
AgentBuilder.Default.Transformation transformation)
Creates a new default agent builder.
|
Modifier and Type | Method and Description |
---|---|
AgentBuilder |
disableBootstrapInjection()
Disables injection of auxiliary classes into the bootstrap class path.
|
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 |
ignore(ElementMatcher<? super TypeDescription> ignoredTypes)
Excludes any type that is matched by the provided matcher from instrumentation.
|
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.Transformer s before loading this type. |
AgentBuilder.Identified |
type(ElementMatcher<? super TypeDescription> typeMatcher)
Matches a type being loaded in order to apply the supplied
AgentBuilder.Transformer s 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.Transformer s 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. |
public Default()
ByteBuddy
instance for
creating classes.public Default(ByteBuddy byteBuddy)
byteBuddy
- The Byte Buddy instance to be used.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, ElementMatcher<? super TypeDescription> ignoredTypes, AgentBuilder.Default.Transformation transformation)
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.ignoredTypes
- A matcher that indicates any type that should be excluded from instrumentation.transformation
- The transformation object for handling type transformations.public AgentBuilder.Identified type(AgentBuilder.RawMatcher matcher)
AgentBuilder
Matches a type being loaded in order to apply the supplied
AgentBuilder.Transformer
s before loading this type.
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.
type
in interface AgentBuilder
matcher
- A matcher that decides if the entailed
AgentBuilder.Transformer
s should be applied for a type that
is being loaded.AgentBuilder.Transformer
s to be applied when the given matcher
indicates a match.public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher)
AgentBuilder
Matches a type being loaded in order to apply the supplied
AgentBuilder.Transformer
s before loading this type.
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.
type
in interface AgentBuilder
typeMatcher
- An ElementMatcher
that is applied on the type being loaded that
decides if the entailed AgentBuilder.Transformer
s should
be applied for that type.AgentBuilder.Transformer
s to be applied when the given typeMatcher
indicates a match.public AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher, ElementMatcher<? super ClassLoader> classLoaderMatcher)
AgentBuilder
Matches a type being loaded in order to apply the supplied
AgentBuilder.Transformer
s before loading this type.
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.
type
in interface AgentBuilder
typeMatcher
- An ElementMatcher
that is applied on the type being
loaded that decides if the entailed
AgentBuilder.Transformer
s 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.AgentBuilder.Transformer
s to be applied when both the given
typeMatcher
and classLoaderMatcher
indicate a match.public AgentBuilder with(ByteBuddy byteBuddy)
AgentBuilder
ByteBuddy
instance to be used by the created agent.with
in interface AgentBuilder
byteBuddy
- The Byte Buddy instance to be used.byteBuddy
instance.public AgentBuilder with(AgentBuilder.Listener listener)
AgentBuilder
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.with
in interface AgentBuilder
listener
- The listener to be notified.public AgentBuilder with(AgentBuilder.TypeStrategy typeStrategy)
AgentBuilder
with
in interface AgentBuilder
typeStrategy
- The definition handler to use.public AgentBuilder with(AgentBuilder.BinaryLocator binaryLocator)
AgentBuilder
with
in interface AgentBuilder
binaryLocator
- The binary locator to use.public AgentBuilder enableNativeMethodPrefix(String prefix)
AgentBuilder
Instrumentation
.enableNativeMethodPrefix
in interface AgentBuilder
prefix
- The prefix to be used.public AgentBuilder disableNativeMethodPrefix()
AgentBuilder
disableNativeMethodPrefix
in interface AgentBuilder
public AgentBuilder with(AccessControlContext accessControlContext)
AgentBuilder
with
in interface AgentBuilder
accessControlContext
- The access control context to be used for loading classes.public AgentBuilder with(AgentBuilder.RedefinitionStrategy redefinitionStrategy)
AgentBuilder
with
in interface AgentBuilder
redefinitionStrategy
- The redefinition strategy to apply.public AgentBuilder with(AgentBuilder.InitializationStrategy initializationStrategy)
AgentBuilder
with
in interface AgentBuilder
initializationStrategy
- The initialization strategy to use.public AgentBuilder enableBootstrapInjection(File folder, Instrumentation instrumentation)
AgentBuilder
enableBootstrapInjection
in interface AgentBuilder
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.public AgentBuilder disableBootstrapInjection()
AgentBuilder
disableBootstrapInjection
in interface AgentBuilder
public AgentBuilder ignore(ElementMatcher<? super TypeDescription> ignoredTypes)
AgentBuilder
Excludes any type that is matched by the provided matcher from instrumentation. By default, Byte Buddy does not instrument synthetic types.
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 prematurely. 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!
ignore
in interface AgentBuilder
ignoredTypes
- A matcher that identifies types that should not be instrumented.public AgentBuilder with(AgentBuilder.LambdaInstrumentationStrategy lambdaInstrumentationStrategy)
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.
with
in interface AgentBuilder
lambdaInstrumentationStrategy
- true
if this feature should be enabled.public ClassFileTransformer makeRaw()
AgentBuilder
ClassFileTransformer
that implements the configuration of this
agent builder.makeRaw
in interface AgentBuilder
public ClassFileTransformer installOn(Instrumentation instrumentation)
AgentBuilder
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.installOn
in interface AgentBuilder
instrumentation
- The instrumentation on which this agent builder's configuration is to be installed.public ClassFileTransformer installOnByteBuddyAgent()
AgentBuilder
ClassFileTransformer
that implements the configuration of
this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.installOnByteBuddyAgent
in interface AgentBuilder
Copyright © 2014–2016. All rights reserved.