AgentBuilder (Byte Buddy (without dependencies) 0.7.6 API)

All Known Subinterfaces:

AgentBuilder.Identified.Extendable

All Known Implementing Classes:

AgentBuilder.Default, AgentBuilder.Default.Matched
```
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.Transformers, the agent builder always applies the transformers that were supplied with the last applicable matcher. Therefore, more general transformers should be defined first.

Nested Class Summary

Nested Classes
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.

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - type
```
AgentBuilder.Identified type(AgentBuilder.RawMatcher matcher)
```
    Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
    
    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
```
AgentBuilder.Identified type(ElementMatcher<? super TypeDescription> typeMatcher)
```
    Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
    
    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
```
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.
    
    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
```
AgentBuilder withByteBuddy(ByteBuddy byteBuddy)
```
    Defines the given ByteBuddy instance to be used by the created agent.
    
    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
```
AgentBuilder withListener(AgentBuilder.Listener listener)
```
    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.
    
    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.
  - withBinaryLocator
```
AgentBuilder withBinaryLocator(AgentBuilder.BinaryLocator binaryLocator)
```
    Defines the use of the given binary locator for locating binary data to given class names.
    
    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.
  - withTypeStrategy
```
AgentBuilder withTypeStrategy(AgentBuilder.TypeStrategy typeStrategy)
```
    Defines the use of the given definition handler that determines if a type should be rebased or redefined.
    
    Parameters:
    
    typeStrategy - The definition handler to use.
    
    Returns:
    
    A new instance of this agent builder which uses the given definition handler.
  - withNativeMethodPrefix
```
AgentBuilder withNativeMethodPrefix(String prefix)
```
    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.
    
    Parameters:
    
    prefix - The prefix to be used.
    
    Returns:
    
    A new instance of this agent builder which uses the given native method prefix.
  - withoutNativeMethodPrefix
```
AgentBuilder withoutNativeMethodPrefix()
```
    Disables the use of a native method prefix for instrumented methods.
    
    Returns:
    
    A new instance of this agent builder which does not use a native method prefix.
  - withAccessControlContext
```
AgentBuilder withAccessControlContext(AccessControlContext accessControlContext)
```
    Defines classes to be loaded using the given access control context.
    
    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.
  - withInitializationStrategy
```
AgentBuilder withInitializationStrategy(AgentBuilder.InitializationStrategy initializationStrategy)
```
    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.
    
    Parameters:
    
    initializationStrategy - The initialization strategy to use.
    
    Returns:
    
    A new instance of this agent builder that applies the given initialization strategy.
  - withRedefinitionStrategy
```
AgentBuilder withRedefinitionStrategy(AgentBuilder.RedefinitionStrategy redefinitionStrategy)
```
    Specifies a strategy for modifying existing types.
    
    Parameters:
    
    redefinitionStrategy - The redefinition strategy to apply.
    
    Returns:
    
    A new instance of this agent builder that applies the given redefinition strategy.
  - enableBootstrapInjection
```
AgentBuilder enableBootstrapInjection(File folder,
                                      Instrumentation instrumentation)
```
    Enables class injection of auxiliary classes into the bootstrap class loader.
    
    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
```
AgentBuilder disableBootstrapInjection()
```
    Disables injection of auxiliary classes into the bootstrap class path.
    
    Returns:
    
    An agent builder with bootstrap class loader class injection disbaled.
  - makeRaw
```
ClassFileTransformer makeRaw()
```
    Creates a ClassFileTransformer that implements the configuration of this agent builder.
    
    Returns:
    
    A class file transformer that implements the configuration of this agent builder.
  - installOn
```
ClassFileTransformer installOn(Instrumentation instrumentation)
```
    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.
    
    Parameters:
    
    instrumentation - The instrumentation on which this agent builder's configuration is to be installed.
    
    Returns:
    
    The installed class file transformer.
  - installOnByteBuddyAgent
```
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.
    
    Returns:
    
    The installed class file transformer.

Interface AgentBuilder

Nested Class Summary

Method Summary

Method Detail

type

type

type

withByteBuddy

withListener

withBinaryLocator

withTypeStrategy

withNativeMethodPrefix

withoutNativeMethodPrefix

withAccessControlContext

withInitializationStrategy

withRedefinitionStrategy

enableBootstrapInjection

disableBootstrapInjection

makeRaw

installOn

installOnByteBuddyAgent