net.bytebuddy.agent.builder

Class AgentBuilder.Default.Matched

java.lang.Object

net.bytebuddy.agent.builder.AgentBuilder.Default.Matched

All Implemented Interfaces:

AgentBuilder, AgentBuilder.Identified, AgentBuilder.Identified.Extendable

Enclosing class:

AgentBuilder.Default

protected class AgentBuilder.Default.Matched
extends Object
implements AgentBuilder.Identified.Extendable

A helper class that describes a AgentBuilder.Default after supplying a AgentBuilder.RawMatcher such that one or several AgentBuilder.Transformers can be supplied.

Nested Class Summary

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

AgentBuilder.BinaryLocator, AgentBuilder.Default, AgentBuilder.Identified, AgentBuilder.Listener, AgentBuilder.RawMatcher, AgentBuilder.Transformer

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

AgentBuilder.Identified.Extendable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Matched(AgentBuilder.RawMatcher rawMatcher, AgentBuilder.Transformer transformer) Creates a new matched default agent builder.

Method Summary

Modifier and Type	Method and Description
AgentBuilder	allowRetransformation() Enables retransformation when this agent is installed.
AgentBuilder	disableSelfInitialization() Disables the execution of any LoadedTypeInitializers that are registered with a DynamicType.
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.
protected AgentBuilder	materialize() Materializes the currently described AgentBuilder.Default.Transformation.
AgentBuilder.Identified	rebase(AgentBuilder.RawMatcher matcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified	rebase(ElementMatcher<? super TypeDescription> typeMatcher) Matches a type being loaded in order to apply the supplied AgentBuilder.Transformers before loading this type.
AgentBuilder.Identified	rebase(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.
String	toString()
AgentBuilder.Identified.Extendable	transform(AgentBuilder.Transformer transformer) Applies the given transformer for the already supplied matcher.
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Matched

protected Matched(AgentBuilder.RawMatcher rawMatcher,
                  AgentBuilder.Transformer transformer)

Creates a new matched default agent builder.

Parameters:

rawMatcher - The supplied raw matcher.

transformer - The supplied transformer.

Method Detail

transform

public AgentBuilder.Identified.Extendable transform(AgentBuilder.Transformer transformer)

Description copied from interface: AgentBuilder.Identified

Applies the given transformer for the already supplied matcher.

Specified by:

transform in interface AgentBuilder.Identified

Parameters:

transformer - The transformer to apply.

Returns:

This agent builder with the transformer being applied when the previously supplied matcher identified a type for instrumentation which also allows for the registration of subsequent transformers.

rebase

public AgentBuilder.Identified rebase(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:

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

rebase

public AgentBuilder.Identified rebase(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:

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

rebase

public AgentBuilder.Identified rebase(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:

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

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.

disableSelfInitialization

public AgentBuilder disableSelfInitialization()

Description copied from interface: AgentBuilder

Disables the execution of any LoadedTypeInitializers that are registered with a DynamicType. This might cause the dynamic type to malfunction if the LoadedTypeInitializer are not executed elsewhere before an instrumented type is put in use for the first time.

In order to execute a self initialization, Byte Buddy adds a call back into any dynamic type's type initializer. This call back requires the injection of a call back dispatcher into the system class loader what might not be a feasible solution on distributed applications where classes are shared among different JVMs where a different strategy for executing LoadedTypeInitializers might be more appropriate.

Specified by:

disableSelfInitialization in interface AgentBuilder

Returns:

A new instance of this agent builder which does not apply self initialization.

allowRetransformation

public AgentBuilder allowRetransformation()

Description copied from interface: AgentBuilder

Enables retransformation when this agent is installed. Note that retransformation on does not currently allow for adding or removing fields or methods on the Hot Spot Virtual machine.

Specified by:

allowRetransformation in interface AgentBuilder

Returns:

A new instance of this agent builder which does not apply self initialization.

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.

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.

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.

materialize

protected AgentBuilder materialize()

Materializes the currently described AgentBuilder.Default.Transformation.

Returns:

An agent builder that represents the currently described entry of this instance.

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