net.bytebuddy.implementation

Class InvocationHandlerAdapter

java.lang.Object

net.bytebuddy.implementation.InvocationHandlerAdapter

All Implemented Interfaces:

InstrumentedType.Prepareable, Implementation, Implementation.Composable

Direct Known Subclasses:

InvocationHandlerAdapter.ForField, InvocationHandlerAdapter.ForInstance

@HashCodeAndEqualsPlugin.Enhance
public abstract class InvocationHandlerAdapter
extends Object
implements Implementation.Composable

An adapter for adapting an InvocationHandler. The adapter allows the invocation handler to also intercept method calls to non-interface methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InvocationHandlerAdapter.AssignerConfigurable Allows for the configuration of an Assigner of an InvocationHandlerAdapter.
protected static class	InvocationHandlerAdapter.ForField An implementation of an InvocationHandlerAdapter that delegates method invocations to an adapter that is stored in an instance field.
protected static class	InvocationHandlerAdapter.ForInstance An implementation of an InvocationHandlerAdapter that delegates method invocations to an adapter that is stored in a static field.
static interface	InvocationHandlerAdapter.WithoutPrivilegeConfiguration Allows the configuration of privileged lookup for the resolution of Method constants that are provided to the invocation handler.

Nested classes/interfaces inherited from interface net.bytebuddy.implementation.Implementation

Implementation.Composable, Implementation.Compound, Implementation.Context, Implementation.Simple, Implementation.SpecialMethodInvocation, Implementation.Target

Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable

InstrumentedType.Prepareable.NoOp

Field Summary

Fields

Modifier and Type	Field and Description
protected Assigner	assigner The assigner that is used for assigning the return invocation handler's return value to the intercepted method's return value.
protected boolean	cached Determines if the Method instances that are handed to the intercepted methods are cached in static fields.
protected String	fieldName The name of the field for storing an invocation handler.
protected boolean	privileged Determines if the Method instances are retrieved by using an java.security.AccessController.
protected boolean	returning Determines if this implementation is returning the result value or is dropping it.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvocationHandlerAdapter(String fieldName, boolean cached, boolean privileged, boolean returning, Assigner assigner) Creates a new invocation handler for a given field.

Method Summary

Modifier and Type	Method and Description
protected ByteCodeAppender.Size	apply(MethodVisitor methodVisitor, Implementation.Context implementationContext, MethodDescription instrumentedMethod, StackManipulation preparingManipulation, FieldDescription fieldDescription) Applies an implementation that delegates to a invocation handler.
static InvocationHandlerAdapter	of(InvocationHandler invocationHandler) Creates an implementation for any instance of an InvocationHandler that delegates all method interceptions to the given instance which will be stored in a static field.
static InvocationHandlerAdapter	of(InvocationHandler invocationHandler, String fieldName) Creates an implementation for any instance of an InvocationHandler that delegates all method interceptions to the given instance which will be stored in a static field.
static InvocationHandlerAdapter	toField(String name) Creates an implementation for any InvocationHandler that delegates all method interceptions to a field with the given name.
static InvocationHandlerAdapter	toField(String name, FieldLocator.Factory fieldLocatorFactory) Creates an implementation for any InvocationHandler that delegates all method interceptions to a field with the given name.
abstract Implementation	withAssigner(Assigner assigner) Configures an assigner to use with this invocation handler adapter.
abstract InvocationHandlerAdapter.WithoutPrivilegeConfiguration	withoutMethodCache() By default, any Method instance that is handed over to an InvocationHandler is cached in a static field.
abstract InvocationHandlerAdapter.AssignerConfigurable	withPrivilegedLookup() Configures that the method constants supplied to the invocation handler adapter are resolved using an java.security.AccessController.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.bytebuddy.implementation.Implementation.Composable

andThen, andThen

Methods inherited from interface net.bytebuddy.implementation.Implementation

appender

Methods inherited from interface net.bytebuddy.dynamic.scaffold.InstrumentedType.Prepareable

prepare

Field Detail

fieldName

protected final String fieldName

The name of the field for storing an invocation handler.

cached

protected final boolean cached

Determines if the Method instances that are handed to the intercepted methods are cached in static fields.

privileged

protected final boolean privileged

Determines if the Method instances are retrieved by using an java.security.AccessController.

returning

protected final boolean returning

Determines if this implementation is returning the result value or is dropping it.

assigner

protected final Assigner assigner

The assigner that is used for assigning the return invocation handler's return value to the intercepted method's return value.

Constructor Detail

InvocationHandlerAdapter

protected InvocationHandlerAdapter(String fieldName,
                                   boolean cached,
                                   boolean privileged,
                                   boolean returning,
                                   Assigner assigner)

Creates a new invocation handler for a given field.

Parameters:

fieldName - The name of the field.

cached - Determines if the Method instances that are handed to the intercepted methods are cached in static fields.

privileged - Determines if the Method instances are retrieved by using an java.security.AccessController.

returning - Determines if this implementation is returning the result value or is dropping it.

assigner - The assigner to apply when defining this implementation.

Method Detail

of

public static InvocationHandlerAdapter of(InvocationHandler invocationHandler)

Creates an implementation for any instance of an InvocationHandler that delegates all method interceptions to the given instance which will be stored in a static field.

Parameters:

invocationHandler - The invocation handler to which all method calls are delegated.

Returns:

An implementation that delegates all method interceptions to the given invocation handler.

of

public static InvocationHandlerAdapter of(InvocationHandler invocationHandler,
                                          String fieldName)

Creates an implementation for any instance of an InvocationHandler that delegates all method interceptions to the given instance which will be stored in a static field.

Parameters:

invocationHandler - The invocation handler to which all method calls are delegated.

fieldName - The name of the field.

Returns:

An implementation that delegates all method interceptions to the given invocation handler.

toField

public static InvocationHandlerAdapter toField(String name)

Creates an implementation for any InvocationHandler that delegates all method interceptions to a field with the given name. This field has to be of a subtype of invocation handler and needs to be set before any invocations are intercepted. Otherwise, a NullPointerException will be thrown.

Parameters:

name - The name of the field.

Returns:

An implementation that delegates all method interceptions to an instance field of the given name.

toField

public static InvocationHandlerAdapter toField(String name,
                                               FieldLocator.Factory fieldLocatorFactory)

Creates an implementation for any InvocationHandler that delegates all method interceptions to a field with the given name. This field has to be of a subtype of invocation handler and needs to be set before any invocations are intercepted. Otherwise, a NullPointerException will be thrown.

Parameters:

name - The name of the field.

fieldLocatorFactory - The field locator factory

Returns:

An implementation that delegates all method interceptions to an instance field of the given name.

withoutMethodCache

public abstract InvocationHandlerAdapter.WithoutPrivilegeConfiguration withoutMethodCache()

By default, any Method instance that is handed over to an InvocationHandler is cached in a static field. By invoking this method, this feature can be disabled.

Returns:

A similar invocation handler adapter that applies caching.

withAssigner

public abstract Implementation withAssigner(Assigner assigner)

Configures an assigner to use with this invocation handler adapter.

Parameters:

assigner - The assigner to apply when defining this implementation.

Returns:

This instrumentation with the given assigner configured.

withPrivilegedLookup

public abstract InvocationHandlerAdapter.AssignerConfigurable withPrivilegedLookup()

Configures that the method constants supplied to the invocation handler adapter are resolved using an java.security.AccessController.

Returns:

This instrumentation with a privileged lookup configured.

apply

protected ByteCodeAppender.Size apply(MethodVisitor methodVisitor,
                                      Implementation.Context implementationContext,
                                      MethodDescription instrumentedMethod,
                                      StackManipulation preparingManipulation,
                                      FieldDescription fieldDescription)

Applies an implementation that delegates to a invocation handler.

Parameters:

methodVisitor - The method visitor for writing the byte code to.

implementationContext - The implementation context for the current implementation.

instrumentedMethod - The method that is instrumented.

preparingManipulation - A stack manipulation that applies any preparation to the operand stack.

fieldDescription - The field that contains the value for the invocation handler.

Returns:

The size of the applied assignment.