net.bytebuddy.agent.builder

Interface AgentBuilder.InstallationListener

All Known Implementing Classes:

AgentBuilder.InstallationListener.Adapter, AgentBuilder.InstallationListener.Compound, AgentBuilder.InstallationListener.ErrorSuppressing, AgentBuilder.InstallationListener.NoOp, AgentBuilder.InstallationListener.StreamWriting, AgentBuilder.RedefinitionStrategy.ResubmissionStrategy.Enabled.ResubmissionInstallationListener

Enclosing interface:

AgentBuilder

public static interface AgentBuilder.InstallationListener

A listener that is notified during the installation and the resetting of a class file transformer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AgentBuilder.InstallationListener.Adapter An adapter implementation for an installation listener that serves as a convenience.
static class	AgentBuilder.InstallationListener.Compound A compound installation listener.
static class	AgentBuilder.InstallationListener.ErrorSuppressing A listener that suppresses any installation error.
static class	AgentBuilder.InstallationListener.NoOp A non-operational listener that does not do anything.
static class	AgentBuilder.InstallationListener.StreamWriting This installation listener prints the status of any installation to a PrintStream.

Field Summary

Fields

Modifier and Type	Field and Description
static Throwable	SUPPRESS_ERROR Indicates that an exception is handled.

Method Summary

Modifier and Type	Method and Description
void	onAfterWarmUp(Map<Class<?>,byte[]> types, ResettableClassFileTransformer classFileTransformer, boolean transformed) Invoked after a warump is executed.
void	onBeforeInstall(Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer) Invoked prior to the installation of a class file transformer.
void	onBeforeWarmUp(Set<Class<?>> types, ResettableClassFileTransformer classFileTransformer) Invoked before a warump is executed.
Throwable	onError(Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer, Throwable throwable) Invoked if an installation causes an error.
void	onInstall(Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer) Invoked upon the successful installation of a class file transformer.
void	onReset(Instrumentation instrumentation, ResettableClassFileTransformer classFileTransformer) Invoked if an installation is reset.
void	onWarmUpError(Class<?> type, ResettableClassFileTransformer classFileTransformer, Throwable throwable) Invoked when a class yields an unexpected error that is not catched by the listener.

Field Detail

SUPPRESS_ERROR

@AlwaysNull
static final Throwable SUPPRESS_ERROR

Indicates that an exception is handled.

Method Detail

onBeforeInstall

void onBeforeInstall(Instrumentation instrumentation,
                     ResettableClassFileTransformer classFileTransformer)

Invoked prior to the installation of a class file transformer.

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

onInstall

void onInstall(Instrumentation instrumentation,
               ResettableClassFileTransformer classFileTransformer)

Invoked upon the successful installation of a class file transformer. This method is only invoked if no error occurred during the installation or if such an error was handled by onError(Instrumentation, ResettableClassFileTransformer, Throwable).

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

onError

@MaybeNull
Throwable onError(Instrumentation instrumentation,
                             ResettableClassFileTransformer classFileTransformer,
                             Throwable throwable)

Invoked if an installation causes an error. The listener has an opportunity to handle the error. This method is invoked prior to onInstall(Instrumentation, ResettableClassFileTransformer).

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

throwable - The throwable that causes the error.

Returns:

The error to propagate or null if the error is handled. Any subsequent listeners are not called if the exception is handled.

onReset

void onReset(Instrumentation instrumentation,
             ResettableClassFileTransformer classFileTransformer)

Invoked if an installation is reset.

Parameters:

instrumentation - The instrumentation on which the class file transformer is installed.

classFileTransformer - The class file transformer that is being installed.

onBeforeWarmUp

void onBeforeWarmUp(Set<Class<?>> types,
                    ResettableClassFileTransformer classFileTransformer)

Invoked before a warump is executed.

Parameters:

types - The types that are used for the warmup.

classFileTransformer - The class file transformer that is warmed up.

onWarmUpError

void onWarmUpError(Class<?> type,
                   ResettableClassFileTransformer classFileTransformer,
                   Throwable throwable)

Invoked when a class yields an unexpected error that is not catched by the listener.

Parameters:

type - The type that caused the error.

classFileTransformer - The class file transformer that is warmed up.

throwable - The throwable that represents the error.

onAfterWarmUp

void onAfterWarmUp(Map<Class<?>,byte[]> types,
                   ResettableClassFileTransformer classFileTransformer,
                   boolean transformed)

Invoked after a warump is executed.

Parameters:

types - The types that are used for the warmup mapped to their transformed byte code or null if the type was not transformed or failed to transform.

classFileTransformer - The class file transformer that is warmed up.

transformed - true if at least one class caused an actual transformation.