Class AccessControllerPlugin

java.lang.Object

net.bytebuddy.build.Plugin.ForElementMatcher

net.bytebuddy.build.AccessControllerPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, Plugin, Plugin.Factory, ElementMatcher<TypeDescription>

@Enhance
public class AccessControllerPlugin
extends Plugin.ForElementMatcher
implements Plugin.Factory

A build tool plugin that instruments methods to dispatch to methods java.security.AccessController with equal signature. This can be useful to avoid using types from the java.security package which were deprecated for removal in Java 17. Annotated methods are dispatched to the JVM's access controller only if this type is available on the current VM, and if no system property is added and set to disable such dispatch. In the process, java.security.AccessControlContext is represented by Object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AccessControllerPlugin.AccessControlWrapper	An wrapper for a method that represents a method of AccessController which is weaved.
static @interface	AccessControllerPlugin.Enhance	Indicates that the annotated method represents a pseudo implementation of java.security.AccessController which can be weaved to dispatch to the access controller if this is possible on the current VM and not explicitly disabled on the current VM via a system property.
protected static class	AccessControllerPlugin.Initializer	A byte code appender to create an initializer segment that determines if the java.security.AccessController is available.

Nested classes/interfaces inherited from interface ElementMatcher

ElementMatcher.Junction<S>

Nested classes/interfaces inherited from interface Plugin

Plugin.Engine, Plugin.Factory, Plugin.ForElementMatcher, Plugin.NoOp, Plugin.WithInitialization, Plugin.WithPreprocessor

Nested classes/interfaces inherited from interface Plugin.Factory

Plugin.Factory.Simple, Plugin.Factory.UsingReflection

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	ACCESS_CONTROLLER	The binary name of java.security.AccessController.
private static final Object[]	EMPTY	An empty array to create frames without additional allocation.
private static final String	NAME	The name of the generated field.
private final String	property	The property to control if the access controller should be used even if available or null if such a property should not be available.
private static final Map<MethodDescription.SignatureToken, MethodDescription.SignatureToken>	SIGNATURES	A map to all signatures of java.security.AccessController from a signature that does not contain any types that are deprecated for removal.

Constructor Summary

Constructors

Constructor	Description
AccessControllerPlugin()	Creates a new plugin to weave access controller dispatches without a property to allow for disabling the access controller handling.
AccessControllerPlugin(String property)	Creates a new plugin to weave access controller dispatches.

Method Summary

Modifier and Type	Method	Description
DynamicType.Builder<?>	apply(DynamicType.Builder<?> builder, TypeDescription typeDescription, ClassFileLocator classFileLocator)	Applies this plugin.
void	close()
Plugin	make()	Returns a plugin that can be used for a transformation and which is subsequently closed.

Methods inherited from class Plugin.ForElementMatcher

matches

Methods inherited from class Object

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

Field Details

ACCESS_CONTROLLER

private static final String ACCESS_CONTROLLER

The binary name of java.security.AccessController.

See Also:

• Constant Field Values

NAME

private static final String NAME

The name of the generated field.

See Also:

• Constant Field Values

EMPTY

private static final Object[] EMPTY

An empty array to create frames without additional allocation.

SIGNATURES

private static final Map<MethodDescription.SignatureToken, MethodDescription.SignatureToken> SIGNATURES

A map to all signatures of java.security.AccessController from a signature that does not contain any types that are deprecated for removal.

property

@MaybeNull
@ValueHandling(REVERSE_NULLABILITY)
private final String property

The property to control if the access controller should be used even if available or null if such a property should not be available.

Constructor Details

AccessControllerPlugin

public AccessControllerPlugin()

Creates a new plugin to weave access controller dispatches without a property to allow for disabling the access controller handling.

AccessControllerPlugin

@Priority(2147483647)
public AccessControllerPlugin(@MaybeNull
 String property)

Creates a new plugin to weave access controller dispatches.

Parameters:

property - The property to control if the access controller should be used even if available or null if such a property should not be available.

Method Details

make

public Plugin make()

Returns a plugin that can be used for a transformation and which is subsequently closed.

Specified by:

make in interface Plugin.Factory

Returns:

The plugin to use for type transformations.

apply

public DynamicType.Builder<?> apply(DynamicType.Builder<?> builder,
 TypeDescription typeDescription,
 ClassFileLocator classFileLocator)

Applies this plugin.

Specified by:

apply in interface Plugin

Parameters:

builder - The builder to use as a basis for the applied transformation.

typeDescription - The type being transformed.

classFileLocator - A class file locator that can locate other types in the scope of the project.

Returns:

The supplied builder with additional transformations registered.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable