public interface AgentBuilder
An agent builder provides a convenience API for defining a
Java agent. By default,
this transformation is applied by rebasing the type if not specified otherwise by setting a
AgentBuilder.TypeStrategy
.
When defining several AgentBuilder.Transformer
s, the agent builder always
applies the transformers that were supplied with the last applicable matcher. Therefore, more general transformers
should be defined first.
Modifier and Type | Interface and Description |
---|---|
static interface |
AgentBuilder.BinaryLocator
A binary locator allows to specify how binary data is located by an
AgentBuilder . |
static class |
AgentBuilder.Default
The default implementation of an
AgentBuilder . |
static interface |
AgentBuilder.Identified
Describes an
AgentBuilder which was handed a matcher for identifying
types to instrumented in order to supply one or several
AgentBuilder.Transformer s. |
static interface |
AgentBuilder.InitializationStrategy
An initialization strategy which determines the handling of
LoadedTypeInitializer s
and the loading of auxiliary types. |
static interface |
AgentBuilder.Listener
A listener that is informed about events that occur during an instrumentation process.
|
static interface |
AgentBuilder.RawMatcher
A matcher that allows to determine if a
AgentBuilder.Transformer
should be applied during the execution of a ClassFileTransformer that was
generated by an AgentBuilder . |
static class |
AgentBuilder.RedefinitionStrategy
A redefinition strategy regulates how already loaded classes are modified by a built agent.
|
static interface |
AgentBuilder.Transformer
A transformer allows to apply modifications to a
DynamicType . |
static interface |
AgentBuilder.TypeStrategy
A type strategy is responsible for creating a type builder for a type that is being instrumented.
|
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.
|
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. |
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 |
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.
|
AgentBuilder.Identified type(AgentBuilder.RawMatcher matcher)
AgentBuilder.Transformer
s before loading this type.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.AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher)
AgentBuilder.Transformer
s before loading this type.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.AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher, ElementMatcher<? super ClassLoader> classLoaderMatcher)
AgentBuilder.Transformer
s before loading this type.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.AgentBuilder withByteBuddy(ByteBuddy byteBuddy)
ByteBuddy
instance to be used by the created agent.byteBuddy
- The Byte Buddy instance to be used.byteBuddy
instance.AgentBuilder withListener(AgentBuilder.Listener listener)
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.listener
- The listener to be notified.AgentBuilder withBinaryLocator(AgentBuilder.BinaryLocator binaryLocator)
binaryLocator
- The binary locator to use.AgentBuilder withTypeStrategy(AgentBuilder.TypeStrategy typeStrategy)
typeStrategy
- The definition handler to use.AgentBuilder withNativeMethodPrefix(String prefix)
Instrumentation
.prefix
- The prefix to be used.AgentBuilder withoutNativeMethodPrefix()
AgentBuilder withAccessControlContext(AccessControlContext accessControlContext)
accessControlContext
- The access control context to be used for loading classes.AgentBuilder withInitializationStrategy(AgentBuilder.InitializationStrategy initializationStrategy)
initializationStrategy
- The initialization strategy to use.AgentBuilder withRedefinitionStrategy(AgentBuilder.RedefinitionStrategy redefinitionStrategy)
redefinitionStrategy
- The redefinition strategy to apply.AgentBuilder enableBootstrapInjection(File folder, Instrumentation instrumentation)
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.AgentBuilder disableBootstrapInjection()
ClassFileTransformer makeRaw()
ClassFileTransformer
that implements the configuration of this
agent builder.ClassFileTransformer installOn(Instrumentation instrumentation)
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.instrumentation
- The instrumentation on which this agent builder's configuration is to be installed.ClassFileTransformer installOnByteBuddyAgent()
ClassFileTransformer
that implements the configuration of
this agent builder with the Byte Buddy-agent which must be installed prior to calling this method.Copyright © 2014–2015. All rights reserved.