net.bytebuddy.dynamic.loading.ClassInjector Maven / Gradle / Ivy
/*
* Copyright 2014 - Present Rafael Winterhalter
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.bytebuddy.dynamic.loading;
import com.sun.jna.*;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.ClassFileVersion;
import net.bytebuddy.asm.MemberRemoval;
import net.bytebuddy.build.AccessControllerPlugin;
import net.bytebuddy.build.HashCodeAndEqualsPlugin;
import net.bytebuddy.description.modifier.Visibility;
import net.bytebuddy.description.type.PackageDescription;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.dynamic.scaffold.TypeValidation;
import net.bytebuddy.dynamic.scaffold.subclass.ConstructorStrategy;
import net.bytebuddy.implementation.FixedValue;
import net.bytebuddy.implementation.MethodCall;
import net.bytebuddy.utility.JavaModule;
import net.bytebuddy.utility.JavaType;
import net.bytebuddy.utility.RandomString;
import net.bytebuddy.utility.dispatcher.JavaDispatcher;
import net.bytebuddy.utility.nullability.AlwaysNull;
import net.bytebuddy.utility.nullability.MaybeNull;
import net.bytebuddy.utility.nullability.UnknownNull;
import net.bytebuddy.utility.privilege.GetMethodAction;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.lang.instrument.Instrumentation;
import java.lang.reflect.*;
import java.net.URL;
import java.security.Permission;
import java.security.PrivilegedAction;
import java.security.ProtectionDomain;
import java.util.*;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import java.util.jar.JarOutputStream;
import static net.bytebuddy.matcher.ElementMatchers.any;
import static net.bytebuddy.matcher.ElementMatchers.named;
/**
*
* A class injector is capable of injecting classes into a {@link java.lang.ClassLoader} without
* requiring the class loader to being able to explicitly look up these classes.
*
*
* Important: Byte Buddy does not supply privileges when injecting code. When using a {@code java.lang.SecurityManager},
* the user of this injector is responsible for providing access to non-public properties.
*
*/
public interface ClassInjector {
/**
* A permission for the {@code suppressAccessChecks} permission.
*/
Permission SUPPRESS_ACCESS_CHECKS = new ReflectPermission("suppressAccessChecks");
/**
* Determines the default behavior for type injections when a type is already loaded.
*/
boolean ALLOW_EXISTING_TYPES = false;
/**
* Indicates if this class injector is available on the current VM.
*
* @return {@code true} if this injector is available on the current VM.
*/
boolean isAlive();
/**
* Injects the given types into the represented class loader.
*
* @param types The types to load via injection.
* @return The loaded types that were passed as arguments.
*/
Map> inject(Map types);
/**
* Injects the given types into the represented class loader using a mapping from name to binary representation.
*
* @param types The types to load via injection.
* @return The loaded types that were passed as arguments.
*/
Map> injectRaw(Map types);
/**
* An abstract base implementation of a class injector.
*/
abstract class AbstractBase implements ClassInjector {
/**
* {@inheritDoc}
*/
public Map> inject(Map types) {
Map binaryRepresentations = new LinkedHashMap();
for (Map.Entry entry : types.entrySet()) {
binaryRepresentations.put(entry.getKey().getName(), entry.getValue());
}
Map> loadedTypes = injectRaw(binaryRepresentations);
Map> result = new LinkedHashMap>();
for (TypeDescription typeDescription : types.keySet()) {
result.put(typeDescription, loadedTypes.get(typeDescription.getName()));
}
return result;
}
}
/**
* A class injector that uses reflective method calls.
*/
@HashCodeAndEqualsPlugin.Enhance
class UsingReflection extends AbstractBase {
/**
* The dispatcher to use for accessing a class loader via reflection.
*/
private static final Dispatcher.Initializable DISPATCHER = doPrivileged(Dispatcher.CreationAction.INSTANCE);
/**
* A proxy for {@code java.lang.System} to access the security manager if available.
*/
private static final System SYSTEM = doPrivileged(JavaDispatcher.of(System.class));
/**
* The {@code java.lang.SecurityManager#checkPermission} method or {@code null} if not available.
*/
private static final Method CHECK_PERMISSION = doPrivileged(new GetMethodAction("java.lang.SecurityManager",
"checkPermission",
Permission.class));
/**
* The class loader into which the classes are to be injected.
*/
private final ClassLoader classLoader;
/**
* The protection domain that is used when loading classes.
*/
@MaybeNull
@HashCodeAndEqualsPlugin.ValueHandling(HashCodeAndEqualsPlugin.ValueHandling.Sort.REVERSE_NULLABILITY)
private final ProtectionDomain protectionDomain;
/**
* The package definer to be queried for package definitions.
*/
private final PackageDefinitionStrategy packageDefinitionStrategy;
/**
* Determines if an exception should be thrown when attempting to load a type that already exists.
*/
private final boolean forbidExisting;
/**
* Creates a new injector for the given {@link java.lang.ClassLoader} and a default {@link java.security.ProtectionDomain} and a
* trivial {@link PackageDefinitionStrategy} which does not trigger an error when discovering existent classes.
*
* @param classLoader The {@link java.lang.ClassLoader} into which new class definitions are to be injected. Must not be the bootstrap loader.
*/
public UsingReflection(ClassLoader classLoader) {
this(classLoader, ClassLoadingStrategy.NO_PROTECTION_DOMAIN);
}
/**
* Creates a new injector for the given {@link java.lang.ClassLoader} and a default {@link PackageDefinitionStrategy} where the
* injection of existent classes does not trigger an error.
*
* @param classLoader The {@link java.lang.ClassLoader} into which new class definitions are to be injected. Must not be the bootstrap loader.
* @param protectionDomain The protection domain to apply during class definition.
*/
public UsingReflection(ClassLoader classLoader, @MaybeNull ProtectionDomain protectionDomain) {
this(classLoader,
protectionDomain,
PackageDefinitionStrategy.Trivial.INSTANCE,
ALLOW_EXISTING_TYPES);
}
/**
* Creates a new injector for the given {@link java.lang.ClassLoader} and {@link java.security.ProtectionDomain}.
*
* @param classLoader The {@link java.lang.ClassLoader} into which new class definitions are to be injected.Must not be the bootstrap loader.
* @param protectionDomain The protection domain to apply during class definition.
* @param packageDefinitionStrategy The package definer to be queried for package definitions.
* @param forbidExisting Determines if an exception should be thrown when attempting to load a type that already exists.
*/
public UsingReflection(ClassLoader classLoader,
@MaybeNull ProtectionDomain protectionDomain,
PackageDefinitionStrategy packageDefinitionStrategy,
boolean forbidExisting) {
if (classLoader == null) {
throw new IllegalArgumentException("Cannot inject classes into the bootstrap class loader");
}
this.classLoader = classLoader;
this.protectionDomain = protectionDomain;
this.packageDefinitionStrategy = packageDefinitionStrategy;
this.forbidExisting = forbidExisting;
}
/**
* A proxy for {@code java.security.AccessController#doPrivileged} that is activated if available.
*
* @param action The action to execute from a privileged context.
* @param The type of the action's resolved value.
* @return The action's resolved value.
*/
@AccessControllerPlugin.Enhance
private static T doPrivileged(PrivilegedAction action) {
return action.run();
}
/**
* {@inheritDoc}
*/
public boolean isAlive() {
return isAvailable();
}
/**
* {@inheritDoc}
*/
public Map> injectRaw(Map types) {
Dispatcher dispatcher = DISPATCHER.initialize();
Map> result = new HashMap>();
for (Map.Entry entry : types.entrySet()) {
synchronized (dispatcher.getClassLoadingLock(classLoader, entry.getKey())) {
Class type = dispatcher.findClass(classLoader, entry.getKey());
if (type == null) {
int packageIndex = entry.getKey().lastIndexOf('.');
if (packageIndex != -1) {
String packageName = entry.getKey().substring(0, packageIndex);
PackageDefinitionStrategy.Definition definition = packageDefinitionStrategy.define(classLoader, packageName, entry.getKey());
if (definition.isDefined()) {
Package definedPackage = dispatcher.getDefinedPackage(classLoader, packageName);
if (definedPackage == null) {
try {
dispatcher.definePackage(classLoader,
packageName,
definition.getSpecificationTitle(),
definition.getSpecificationVersion(),
definition.getSpecificationVendor(),
definition.getImplementationTitle(),
definition.getImplementationVersion(),
definition.getImplementationVendor(),
definition.getSealBase());
} catch (IllegalStateException exception) {
// Custom classloaders may call getPackage (instead of getDefinedPackage) from
// within definePackage, which can cause the package to be defined in an
// ancestor classloader or find a previously defined one from an ancestor. In
// this case definePackage will also throw since it considers that package
// already loaded and will not allow to define it directly in this classloader.
// To make sure this is the case, call getPackage instead of getDefinedPackage
// here and verify that we actually have a compatible package defined in an
// ancestor classloader. This issue is known to happen on WLS14+JDK11.
definedPackage = dispatcher.getPackage(classLoader, packageName);
if (definedPackage == null) {
throw exception;
} else if (!definition.isCompatibleTo(definedPackage)) {
throw new SecurityException("Sealing violation for package " + packageName + " (getPackage fallback)");
}
}
} else if (!definition.isCompatibleTo(definedPackage)) {
throw new SecurityException("Sealing violation for package " + packageName);
}
}
}
type = dispatcher.defineClass(classLoader, entry.getKey(), entry.getValue(), protectionDomain);
} else if (forbidExisting) {
throw new IllegalStateException("Cannot inject already loaded type: " + type);
}
result.put(entry.getKey(), type);
}
}
return result;
}
/**
* Indicates if this class injection is available on the current VM.
*
* @return {@code true} if this class injection is available.
*/
public static boolean isAvailable() {
return DISPATCHER.isAvailable();
}
/**
* Creates a class injector for the system class loader.
*
* @return A class injector for the system class loader.
*/
public static ClassInjector ofSystemClassLoader() {
return new UsingReflection(ClassLoader.getSystemClassLoader());
}
/**
* A dispatcher for accessing a {@link ClassLoader} reflectively.
*/
protected interface Dispatcher {
/**
* Indicates a class that is currently not defined.
*/
@AlwaysNull
Class UNDEFINED = null;
/**
* Returns the lock for loading the specified class.
*
* @param classLoader the class loader to inject the class into.
* @param name The name of the class.
* @return The lock for loading this class.
*/
Object getClassLoadingLock(ClassLoader classLoader, String name);
/**
* Looks up a class from the given class loader.
*
* @param classLoader The class loader for which a class should be located.
* @param name The binary name of the class that should be located.
* @return The class for the binary name or {@code null} if no such class is defined for the provided class loader.
*/
@MaybeNull
Class findClass(ClassLoader classLoader, String name);
/**
* Defines a class for the given class loader.
*
* @param classLoader The class loader for which a new class should be defined.
* @param name The binary name of the class that should be defined.
* @param binaryRepresentation The binary representation of the class.
* @param protectionDomain The protection domain for the defined class.
* @return The defined, loaded class.
*/
Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain);
/**
* Looks up a package from a class loader. If the operation is not supported, falls back to {@link #getPackage(ClassLoader, String)}
*
* @param classLoader The class loader to query.
* @param name The binary name of the package.
* @return The package for the given name as defined by the provided class loader or {@code null} if no such package exists.
*/
@MaybeNull
Package getDefinedPackage(ClassLoader classLoader, String name);
/**
* Looks up a package from a class loader or its ancestor.
*
* @param classLoader The class loader to query.
* @param name The binary name of the package.
* @return The package for the given name as defined by the provided class loader or its ancestor, or {@code null} if no such package exists.
*/
@MaybeNull
Package getPackage(ClassLoader classLoader, String name);
/**
* Defines a package for the given class loader.
*
* @param classLoader The class loader for which a package is to be defined.
* @param name The binary name of the package.
* @param specificationTitle The specification title of the package or {@code null} if no specification title exists.
* @param specificationVersion The specification version of the package or {@code null} if no specification version exists.
* @param specificationVendor The specification vendor of the package or {@code null} if no specification vendor exists.
* @param implementationTitle The implementation title of the package or {@code null} if no implementation title exists.
* @param implementationVersion The implementation version of the package or {@code null} if no implementation version exists.
* @param implementationVendor The implementation vendor of the package or {@code null} if no implementation vendor exists.
* @param sealBase The seal base URL or {@code null} if the package should not be sealed.
* @return The defined package.
*/
Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase);
/**
* Initializes a dispatcher to make non-accessible APIs accessible.
*/
interface Initializable {
/**
* Indicates if this dispatcher is available.
*
* @return {@code true} if this dispatcher is available.
*/
boolean isAvailable();
/**
* Initializes this dispatcher.
*
* @return The initialized dispatcher.
*/
Dispatcher initialize();
/**
* Represents an unsuccessfully loaded method lookup.
*/
@HashCodeAndEqualsPlugin.Enhance
class Unavailable implements Dispatcher, Initializable {
/**
* The reason why this dispatcher is not available.
*/
private final String message;
/**
* Creates a new faulty reflection store.
*
* @param message The reason why this dispatcher is not available.
*/
protected Unavailable(String message) {
this.message = message;
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return false;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
return this;
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
return classLoader;
}
/**
* {@inheritDoc}
*/
public Class findClass(ClassLoader classLoader, String name) {
try {
return classLoader.loadClass(name);
} catch (ClassNotFoundException ignored) {
return UNDEFINED;
}
}
/**
* {@inheritDoc}
*/
public Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
throw new UnsupportedOperationException("Cannot define class using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package getDefinedPackage(ClassLoader classLoader, String name) {
throw new UnsupportedOperationException("Cannot get defined package using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package getPackage(ClassLoader classLoader, String name) {
throw new UnsupportedOperationException("Cannot get package using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase) {
throw new UnsupportedOperationException("Cannot define package using injection: " + message);
}
}
}
/**
* A creation action for a dispatcher.
*/
enum CreationAction implements PrivilegedAction {
/**
* The singleton instance.
*/
INSTANCE;
/**
* {@inheritDoc}
*/
@SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "Exception should not be rethrown but trigger a fallback.")
public Initializable run() {
try {
if (JavaModule.isSupported()) {
return UsingUnsafe.isAvailable()
? UsingUnsafeInjection.make()
: UsingUnsafeOverride.make();
} else {
return Direct.make();
}
} catch (InvocationTargetException exception) {
return new Initializable.Unavailable(exception.getTargetException().getMessage());
} catch (Exception exception) {
return new Initializable.Unavailable(exception.getMessage());
}
}
}
/**
* A class injection dispatcher that is using reflection on the {@link ClassLoader} methods.
*/
@HashCodeAndEqualsPlugin.Enhance
abstract class Direct implements Dispatcher, Initializable {
/**
* An instance of {@link ClassLoader#findLoadedClass(String)}.
*/
protected final Method findLoadedClass;
/**
* An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
*/
protected final Method defineClass;
/**
* An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
*/
@UnknownNull
protected final Method getDefinedPackage;
/**
* An instance of {@link ClassLoader#getPackage(String)}.
*/
protected final Method getPackage;
/**
* An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected final Method definePackage;
/**
* Creates a new direct injection dispatcher.
*
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected Direct(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage) {
this.findLoadedClass = findLoadedClass;
this.defineClass = defineClass;
this.getDefinedPackage = getDefinedPackage;
this.getPackage = getPackage;
this.definePackage = definePackage;
}
/**
* Creates a direct dispatcher.
*
* @return A direct dispatcher for class injection.
* @throws Exception If the creation is impossible.
*/
@SuppressFBWarnings(value = "DP_DO_INSIDE_DO_PRIVILEGED", justification = "Assuring privilege is explicit user responsibility.")
protected static Initializable make() throws Exception {
Method getDefinedPackage;
if (JavaModule.isSupported()) { // Avoid accidental lookup of method with same name in Java 8 J9 VM.
try {
getDefinedPackage = ClassLoader.class.getMethod("getDefinedPackage", String.class);
} catch (NoSuchMethodException ignored) {
getDefinedPackage = null;
}
} else {
getDefinedPackage = null;
}
Method getPackage = ClassLoader.class.getDeclaredMethod("getPackage", String.class);
getPackage.setAccessible(true);
Method findLoadedClass = ClassLoader.class.getDeclaredMethod("findLoadedClass", String.class);
findLoadedClass.setAccessible(true);
Method defineClass = ClassLoader.class.getDeclaredMethod("defineClass",
String.class,
byte[].class,
int.class,
int.class,
ProtectionDomain.class);
defineClass.setAccessible(true);
Method definePackage = ClassLoader.class.getDeclaredMethod("definePackage",
String.class,
String.class,
String.class,
String.class,
String.class,
String.class,
String.class,
URL.class);
definePackage.setAccessible(true);
try {
Method getClassLoadingLock = ClassLoader.class.getDeclaredMethod("getClassLoadingLock", String.class);
getClassLoadingLock.setAccessible(true);
return new ForJava7CapableVm(findLoadedClass,
defineClass,
getDefinedPackage,
getPackage,
definePackage,
getClassLoadingLock);
} catch (NoSuchMethodException ignored) {
return new ForLegacyVm(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
}
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return true;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
Object securityManager = SYSTEM.getSecurityManager();
if (securityManager != null) {
try {
CHECK_PERMISSION.invoke(securityManager, SUPPRESS_ACCESS_CHECKS);
} catch (InvocationTargetException exception) {
return new Dispatcher.Unavailable(exception.getTargetException().getMessage());
} catch (Exception exception) {
return new Dispatcher.Unavailable(exception.getMessage());
}
}
return this;
}
/**
* {@inheritDoc}
*/
public Class findClass(ClassLoader classLoader, String name) {
try {
return (Class) findLoadedClass.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
try {
return (Class) defineClass.invoke(classLoader, name, binaryRepresentation, 0, binaryRepresentation.length, protectionDomain);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
@MaybeNull
public Package getDefinedPackage(ClassLoader classLoader, String name) {
if (getDefinedPackage == null) {
return getPackage(classLoader, name);
}
try {
return (Package) getDefinedPackage.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package getPackage(ClassLoader classLoader, String name) {
try {
return (Package) getPackage.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase) {
try {
return (Package) definePackage.invoke(classLoader,
name,
specificationTitle,
specificationVersion,
specificationVendor,
implementationTitle,
implementationVersion,
implementationVendor,
sealBase);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* A resolved class dispatcher for a class injector on a VM running at least Java 7.
*/
@HashCodeAndEqualsPlugin.Enhance
protected static class ForJava7CapableVm extends Direct {
/**
* An instance of {@code ClassLoader#getClassLoadingLock(String)}.
*/
private final Method getClassLoadingLock;
/**
* Creates a new resolved reflection store for a VM running at least Java 7.
*
* @param getClassLoadingLock An instance of {@code ClassLoader#getClassLoadingLock(String)}.
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang,ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected ForJava7CapableVm(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage,
Method getClassLoadingLock) {
super(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
this.getClassLoadingLock = getClassLoadingLock;
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
try {
return getClassLoadingLock.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
}
/**
* A resolved class dispatcher for a class injector prior to Java 7.
*/
protected static class ForLegacyVm extends Direct {
/**
* Creates a new resolved reflection store for a VM prior to Java 8.
*
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected ForLegacyVm(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage) {
super(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
return classLoader;
}
}
}
/**
* An indirect dispatcher that uses a redirection accessor class that was injected into the bootstrap class loader.
*/
@HashCodeAndEqualsPlugin.Enhance
class UsingUnsafeInjection implements Dispatcher, Initializable {
/**
* An instance of the accessor class that is required for using it's intentionally non-static methods.
*/
private final Object accessor;
/**
* The accessor method for using {@link ClassLoader#findLoadedClass(String)}.
*/
private final Method findLoadedClass;
/**
* The accessor method for using {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
*/
private final Method defineClass;
/**
* The accessor method for using {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
*/
@UnknownNull
private final Method getDefinedPackage;
/**
* The accessor method for using {@link ClassLoader#getPackage(String)}.
*/
private final Method getPackage;
/**
* The accessor method for using {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
private final Method definePackage;
/**
* The accessor method for using {@code ClassLoader#getClassLoadingLock(String)} or returning the supplied {@link ClassLoader}
* if this method does not exist on the current VM.
*/
private final Method getClassLoadingLock;
/**
* Creates a new class loading injection dispatcher using an unsafe injected dispatcher.
*
* @param accessor An instance of the accessor class that is required for using it's intentionally non-static methods.
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
* @param getClassLoadingLock The accessor method for using {@code ClassLoader#getClassLoadingLock(String)} or returning the
* supplied {@link ClassLoader} if this method does not exist on the current VM.
*/
protected UsingUnsafeInjection(Object accessor,
Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage,
Method getClassLoadingLock) {
this.accessor = accessor;
this.findLoadedClass = findLoadedClass;
this.defineClass = defineClass;
this.getDefinedPackage = getDefinedPackage;
this.getPackage = getPackage;
this.definePackage = definePackage;
this.getClassLoadingLock = getClassLoadingLock;
}
/**
* Creates an indirect dispatcher.
*
* @return An indirect dispatcher for class creation.
* @throws Exception If the dispatcher cannot be created.
*/
@SuppressFBWarnings(value = "DP_DO_INSIDE_DO_PRIVILEGED", justification = "Assuring privilege is explicit user responsibility.")
protected static Initializable make() throws Exception {
if (Boolean.getBoolean(UsingUnsafe.SAFE_PROPERTY)) {
return new Initializable.Unavailable("Use of Unsafe was disabled by system property");
}
Class unsafe = Class.forName("sun.misc.Unsafe");
Field theUnsafe = unsafe.getDeclaredField("theUnsafe");
theUnsafe.setAccessible(true);
Object unsafeInstance = theUnsafe.get(null);
Method getDefinedPackage;
if (JavaModule.isSupported()) { // Avoid accidental lookup of method with same name in Java 8 J9 VM.
try {
getDefinedPackage = ClassLoader.class.getDeclaredMethod("getDefinedPackage", String.class);
} catch (NoSuchMethodException ignored) {
getDefinedPackage = null;
}
} else {
getDefinedPackage = null;
}
DynamicType.Builder builder = new ByteBuddy()
.with(TypeValidation.DISABLED)
.subclass(Object.class, ConstructorStrategy.Default.NO_CONSTRUCTORS)
.name(ClassLoader.class.getName() + "$ByteBuddyAccessor$" + RandomString.make())
.defineMethod("findLoadedClass", Class.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class)
.intercept(MethodCall.invoke(ClassLoader.class
.getDeclaredMethod("findLoadedClass", String.class))
.onArgument(0)
.withArgument(1))
.defineMethod("defineClass", Class.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class, byte[].class, int.class, int.class,
ProtectionDomain.class)
.intercept(MethodCall.invoke(ClassLoader.class
.getDeclaredMethod("defineClass", String.class, byte[].class, int.class, int.class, ProtectionDomain.class))
.onArgument(0)
.withArgument(1, 2, 3, 4, 5))
.defineMethod("getPackage", Package.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class)
.intercept(MethodCall.invoke(ClassLoader.class
.getDeclaredMethod("getPackage", String.class))
.onArgument(0)
.withArgument(1))
.defineMethod("definePackage", Package.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class, String.class, String.class, String.class,
String.class, String.class, String.class, URL.class)
.intercept(MethodCall.invoke(ClassLoader.class
.getDeclaredMethod("definePackage", String.class, String.class, String.class, String.class, String.class, String.class, String.class, URL.class))
.onArgument(0)
.withArgument(1, 2, 3, 4, 5, 6, 7, 8));
if (getDefinedPackage != null) {
builder = builder
.defineMethod("getDefinedPackage", Package.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class)
.intercept(MethodCall.invoke(getDefinedPackage)
.onArgument(0)
.withArgument(1));
}
try {
builder = builder.defineMethod("getClassLoadingLock", Object.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class)
.intercept(MethodCall.invoke(ClassLoader.class.getDeclaredMethod("getClassLoadingLock", String.class))
.onArgument(0)
.withArgument(1));
} catch (NoSuchMethodException ignored) {
builder = builder.defineMethod("getClassLoadingLock", Object.class, Visibility.PUBLIC)
.withParameters(ClassLoader.class, String.class)
.intercept(FixedValue.argument(0));
}
Class type = builder.make()
.load(ClassLoadingStrategy.BOOTSTRAP_LOADER, new ClassLoadingStrategy.ForUnsafeInjection())
.getLoaded();
return new UsingUnsafeInjection(
unsafe.getMethod("allocateInstance", Class.class).invoke(unsafeInstance, type),
type.getMethod("findLoadedClass", ClassLoader.class, String.class),
type.getMethod("defineClass", ClassLoader.class, String.class, byte[].class, int.class, int.class, ProtectionDomain.class),
getDefinedPackage != null ? type.getMethod("getDefinedPackage", ClassLoader.class, String.class) : null,
type.getMethod("getPackage", ClassLoader.class, String.class),
type.getMethod("definePackage", ClassLoader.class, String.class, String.class, String.class, String.class, String.class, String.class, String.class, URL.class),
type.getMethod("getClassLoadingLock", ClassLoader.class, String.class));
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return true;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
Object securityManager = SYSTEM.getSecurityManager();
if (securityManager != null) {
try {
CHECK_PERMISSION.invoke(securityManager, SUPPRESS_ACCESS_CHECKS);
} catch (InvocationTargetException exception) {
return new Dispatcher.Unavailable(exception.getTargetException().getMessage());
} catch (Exception exception) {
return new Dispatcher.Unavailable(exception.getMessage());
}
}
return this;
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
try {
return getClassLoadingLock.invoke(accessor, classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Class findClass(ClassLoader classLoader, String name) {
try {
return (Class) findLoadedClass.invoke(accessor, classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
try {
return (Class) defineClass.invoke(accessor, classLoader, name, binaryRepresentation, 0, binaryRepresentation.length, protectionDomain);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
@MaybeNull
public Package getDefinedPackage(ClassLoader classLoader, String name) {
if (getDefinedPackage == null) {
return getPackage(classLoader, name);
}
try {
return (Package) getDefinedPackage.invoke(accessor, classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package getPackage(ClassLoader classLoader, String name) {
try {
return (Package) getPackage.invoke(accessor, classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase) {
try {
return (Package) definePackage.invoke(accessor,
classLoader,
name,
specificationTitle,
specificationVersion,
specificationVendor,
implementationTitle,
implementationVersion,
implementationVendor,
sealBase);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
}
/**
* A dispatcher implementation that uses {@code sun.misc.Unsafe#putBoolean} to set the {@link AccessibleObject} field
* for making methods accessible.
*/
abstract class UsingUnsafeOverride implements Dispatcher, Initializable {
/**
* An instance of {@link ClassLoader#findLoadedClass(String)}.
*/
protected final Method findLoadedClass;
/**
* An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
*/
protected final Method defineClass;
/**
* An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
*/
@MaybeNull
protected final Method getDefinedPackage;
/**
* An instance of {@link ClassLoader#getPackage(String)}.
*/
protected final Method getPackage;
/**
* An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected final Method definePackage;
/**
* Creates a new unsafe field injecting injection dispatcher.
*
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected UsingUnsafeOverride(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage) {
this.findLoadedClass = findLoadedClass;
this.defineClass = defineClass;
this.getDefinedPackage = getDefinedPackage;
this.getPackage = getPackage;
this.definePackage = definePackage;
}
/**
* Creates a new initializable class injector using an unsafe field injection.
*
* @return An appropriate initializable.
* @throws Exception If the injector cannot be created.
*/
@SuppressFBWarnings(value = "DP_DO_INSIDE_DO_PRIVILEGED", justification = "Assuring privilege is explicit user responsibility.")
protected static Initializable make() throws Exception {
if (Boolean.getBoolean(UsingUnsafe.SAFE_PROPERTY)) {
return new Initializable.Unavailable("Use of Unsafe was disabled by system property");
}
Class unsafeType = Class.forName("sun.misc.Unsafe");
Field theUnsafe = unsafeType.getDeclaredField("theUnsafe");
theUnsafe.setAccessible(true);
Object unsafe = theUnsafe.get(null);
Field override;
try {
override = AccessibleObject.class.getDeclaredField("override");
} catch (NoSuchFieldException ignored) {
// Since Java 12, the override field is hidden from the reflection API. To circumvent this, we
// create a mirror class of AccessibleObject that defines the same fields and has the same field
// layout such that the override field will receive the same class offset. Doing so, we can write to
// the offset location and still set a value to it, despite it being hidden from the reflection API.
override = new ByteBuddy()
.redefine(AccessibleObject.class)
.name("net.bytebuddy.mirror." + AccessibleObject.class.getSimpleName())
.noNestMate()
.visit(new MemberRemoval().stripInvokables(any()))
.make()
.load(AccessibleObject.class.getClassLoader(), ClassLoadingStrategy.Default.WRAPPER)
.getLoaded()
.getDeclaredField("override");
}
long offset = (Long) unsafeType
.getMethod("objectFieldOffset", Field.class)
.invoke(unsafe, override);
Method putBoolean = unsafeType.getMethod("putBoolean", Object.class, long.class, boolean.class);
Method getDefinedPackage;
if (JavaModule.isSupported()) { // Avoid accidental lookup of method with same name in Java 8 J9 VM.
try {
getDefinedPackage = ClassLoader.class.getMethod("getDefinedPackage", String.class);
} catch (NoSuchMethodException ignored) {
getDefinedPackage = null;
}
} else {
getDefinedPackage = null;
}
Method getPackage = ClassLoader.class.getDeclaredMethod("getPackage", String.class);
putBoolean.invoke(unsafe, getPackage, offset, true);
Method findLoadedClass = ClassLoader.class.getDeclaredMethod("findLoadedClass", String.class);
Method defineClass = ClassLoader.class.getDeclaredMethod("defineClass",
String.class,
byte[].class,
int.class,
int.class,
ProtectionDomain.class);
Method definePackage = ClassLoader.class.getDeclaredMethod("definePackage",
String.class,
String.class,
String.class,
String.class,
String.class,
String.class,
String.class,
URL.class);
putBoolean.invoke(unsafe, defineClass, offset, true);
putBoolean.invoke(unsafe, findLoadedClass, offset, true);
putBoolean.invoke(unsafe, definePackage, offset, true);
try {
Method getClassLoadingLock = ClassLoader.class.getDeclaredMethod("getClassLoadingLock", String.class);
putBoolean.invoke(unsafe, getClassLoadingLock, offset, true);
return new ForJava7CapableVm(findLoadedClass,
defineClass,
getDefinedPackage,
getPackage,
definePackage,
getClassLoadingLock);
} catch (NoSuchMethodException ignored) {
return new ForLegacyVm(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
}
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return true;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
Object securityManager = SYSTEM.getSecurityManager();
if (securityManager != null) {
try {
CHECK_PERMISSION.invoke(securityManager, SUPPRESS_ACCESS_CHECKS);
} catch (InvocationTargetException exception) {
return new Dispatcher.Unavailable(exception.getTargetException().getMessage());
} catch (Exception exception) {
return new Dispatcher.Unavailable(exception.getMessage());
}
}
return this;
}
/**
* {@inheritDoc}
*/
public Class findClass(ClassLoader classLoader, String name) {
try {
return (Class) findLoadedClass.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
try {
return (Class) defineClass.invoke(classLoader, name, binaryRepresentation, 0, binaryRepresentation.length, protectionDomain);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
@MaybeNull
public Package getDefinedPackage(ClassLoader classLoader, String name) {
if (getDefinedPackage == null) {
return getPackage(classLoader, name);
}
try {
return (Package) getDefinedPackage.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package getPackage(ClassLoader classLoader, String name) {
try {
return (Package) getPackage.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* {@inheritDoc}
*/
public Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase) {
try {
return (Package) definePackage.invoke(classLoader,
name,
specificationTitle,
specificationVersion,
specificationVendor,
implementationTitle,
implementationVersion,
implementationVendor,
sealBase);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
/**
* A resolved class dispatcher using unsafe field injection for a class injector on a VM running at least Java 7.
*/
@HashCodeAndEqualsPlugin.Enhance
protected static class ForJava7CapableVm extends UsingUnsafeOverride {
/**
* An instance of {@code ClassLoader#getClassLoadingLock(String)}.
*/
private final Method getClassLoadingLock;
/**
* Creates a new resolved class injector using unsafe field injection for a VM running at least Java 7.
*
* @param getClassLoadingLock An instance of {@code ClassLoader#getClassLoadingLock(String)}.
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected ForJava7CapableVm(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage,
Method getClassLoadingLock) {
super(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
this.getClassLoadingLock = getClassLoadingLock;
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
try {
return getClassLoadingLock.invoke(classLoader, name);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
}
/**
* A resolved class dispatcher using unsafe field injection for a class injector prior to Java 7.
*/
protected static class ForLegacyVm extends UsingUnsafeOverride {
/**
* Creates a new resolved class injector using unsafe field injection for a VM prior to Java 7.
*
* @param findLoadedClass An instance of {@link ClassLoader#findLoadedClass(String)}.
* @param defineClass An instance of {@link ClassLoader#defineClass(String, byte[], int, int, ProtectionDomain)}.
* @param getDefinedPackage An instance of {@code java.lang.ClassLoader#getDefinedPackage(String)}. May be {@code null}.
* @param getPackage An instance of {@link ClassLoader#getPackage(String)}.
* @param definePackage An instance of {@link ClassLoader#definePackage(String, String, String, String, String, String, String, URL)}.
*/
protected ForLegacyVm(Method findLoadedClass,
Method defineClass,
@MaybeNull Method getDefinedPackage,
Method getPackage,
Method definePackage) {
super(findLoadedClass, defineClass, getDefinedPackage, getPackage, definePackage);
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
return classLoader;
}
}
}
/**
* Represents an unsuccessfully loaded method lookup.
*/
@HashCodeAndEqualsPlugin.Enhance
class Unavailable implements Dispatcher {
/**
* The error message being displayed.
*/
private final String message;
/**
* Creates a dispatcher for a VM that does not support reflective injection.
*
* @param message The error message being displayed.
*/
protected Unavailable(String message) {
this.message = message;
}
/**
* {@inheritDoc}
*/
public Object getClassLoadingLock(ClassLoader classLoader, String name) {
return classLoader;
}
/**
* {@inheritDoc}
*/
public Class findClass(ClassLoader classLoader, String name) {
try {
return classLoader.loadClass(name);
} catch (ClassNotFoundException ignored) {
return UNDEFINED;
}
}
/**
* {@inheritDoc}
*/
public Class defineClass(ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
throw new UnsupportedOperationException("Cannot define class using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package getDefinedPackage(ClassLoader classLoader, String name) {
throw new UnsupportedOperationException("Cannot get defined package using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package getPackage(ClassLoader classLoader, String name) {
throw new UnsupportedOperationException("Cannot get package using reflection: " + message);
}
/**
* {@inheritDoc}
*/
public Package definePackage(ClassLoader classLoader,
String name,
@MaybeNull String specificationTitle,
@MaybeNull String specificationVersion,
@MaybeNull String specificationVendor,
@MaybeNull String implementationTitle,
@MaybeNull String implementationVersion,
@MaybeNull String implementationVendor,
@MaybeNull URL sealBase) {
throw new UnsupportedOperationException("Cannot define package using injection: " + message);
}
}
}
/**
* A proxy of {@code java.lang.System}.
*/
@JavaDispatcher.Proxied("java.lang.System")
protected interface System {
/**
* Returns the current security manager or {@code null} if not available.
*
* @return The current security manager or {@code null} if not available.
*/
@MaybeNull
@JavaDispatcher.IsStatic
@JavaDispatcher.Defaults
Object getSecurityManager();
}
}
/**
*
* A class injector that uses a {@code java.lang.invoke.MethodHandles$Lookup} object for defining a class.
*
*
* Important: This functionality is only available starting from Java 9.
*
*/
@HashCodeAndEqualsPlugin.Enhance
class UsingLookup extends AbstractBase {
/**
* The dispatcher to interacting with instances of {@code java.lang.invoke.MethodHandles}.
*/
private static final MethodHandles METHOD_HANDLES = doPrivileged(JavaDispatcher.of(MethodHandles.class));
/**
* The dispatcher to interacting with {@code java.lang.invoke.MethodHandles$Lookup}.
*/
private static final MethodHandles.Lookup METHOD_HANDLES_LOOKUP = doPrivileged(JavaDispatcher.of(MethodHandles.Lookup.class));
/**
* Indicates a lookup instance's package lookup mode.
*/
private static final int PACKAGE_LOOKUP = 0x8;
/**
* The {@code java.lang.invoke.MethodHandles$Lookup} to use.
*/
private final Object lookup;
/**
* Creates a new class injector using a lookup instance.
*
* @param lookup The {@code java.lang.invoke.MethodHandles$Lookup} instance to use.
*/
protected UsingLookup(Object lookup) {
this.lookup = lookup;
}
/**
* A proxy for {@code java.security.AccessController#doPrivileged} that is activated if available.
*
* @param action The action to execute from a privileged context.
* @param The type of the action's resolved value.
* @return The action's resolved value.
*/
@AccessControllerPlugin.Enhance
private static T doPrivileged(PrivilegedAction action) {
return action.run();
}
/**
* Creates class injector that defines a class using a method handle lookup.
*
* @param lookup The {@code java.lang.invoke.MethodHandles$Lookup} instance to use.
* @return An appropriate class injector.
*/
public static UsingLookup of(Object lookup) {
if (!isAvailable()) {
throw new IllegalStateException("The current VM does not support class definition via method handle lookups");
} else if (!JavaType.METHOD_HANDLES_LOOKUP.isInstance(lookup)) {
throw new IllegalArgumentException("Not a method handle lookup: " + lookup);
} else if ((METHOD_HANDLES_LOOKUP.lookupModes(lookup) & PACKAGE_LOOKUP) == 0) {
throw new IllegalArgumentException("Lookup does not imply package-access: " + lookup);
}
return new UsingLookup(lookup);
}
/**
* Returns the lookup type this injector is based upon.
*
* @return The lookup type.
*/
public Class lookupType() {
return METHOD_HANDLES_LOOKUP.lookupClass(lookup);
}
/**
* Resolves this injector to use the supplied type's scope.
*
* @param type The type to resolve the access scope for.
* @return An new injector with the specified scope.
*/
public UsingLookup in(Class type) {
try {
return new UsingLookup(METHOD_HANDLES.privateLookupIn(type, lookup));
} catch (IllegalAccessException exception) {
throw new IllegalStateException("Cannot access " + type.getName() + " from " + lookup, exception);
}
}
/**
* {@inheritDoc}
*/
public boolean isAlive() {
return isAvailable();
}
/**
* {@inheritDoc}
*/
public Map> injectRaw(Map types) {
PackageDescription target = TypeDescription.ForLoadedType.of(lookupType()).getPackage();
if (target == null) {
throw new IllegalStateException("Cannot inject into default package");
}
Map> result = new HashMap>();
for (Map.Entry entry : types.entrySet()) {
int index = entry.getKey().lastIndexOf('.');
if (!target.getName().equals(index == -1 ? "" : entry.getKey().substring(0, index))) {
throw new IllegalArgumentException(entry.getKey() + " must be defined in the same package as " + lookup);
}
try {
result.put(entry.getKey(), METHOD_HANDLES_LOOKUP.defineClass(lookup, entry.getValue()));
} catch (Exception exception) {
throw new IllegalStateException(exception);
}
}
return result;
}
/**
* Checks if the current VM is capable of defining classes using a method handle lookup.
*
* @return {@code true} if the current VM is capable of defining classes using a lookup.
*/
public static boolean isAvailable() {
return JavaType.MODULE.isAvailable();
}
/**
* A dispatcher for {@code java.lang.invoke.MethodHandles}.
*/
@JavaDispatcher.Proxied("java.lang.invoke.MethodHandles")
protected interface MethodHandles {
/**
* Resolves the supplied lookup instance's access scope for the supplied type.
*
* @param type The type to resolve the scope for.
* @param lookup The lookup to resolve.
* @return An appropriate lookup instance.
* @throws IllegalAccessException If an illegal access occurs.
*/
@JavaDispatcher.IsStatic
Object privateLookupIn(Class type, @JavaDispatcher.Proxied("java.lang.invoke.MethodHandles$Lookup") Object lookup) throws IllegalAccessException;
/**
* A dispatcher for {@code java.lang.invoke.MethodHandles$Lookup}.
*/
@JavaDispatcher.Proxied("java.lang.invoke.MethodHandles$Lookup")
interface Lookup {
/**
* Returns the lookup type for a given method handle lookup.
*
* @param lookup The lookup instance.
* @return The lookup type.
*/
Class lookupClass(Object lookup);
/**
* Returns a lookup objects lookup types.
*
* @param lookup The lookup instance.
* @return The modifiers indicating the instance's lookup modes.
*/
int lookupModes(Object lookup);
/**
* Defines the represented class.
*
* @param lookup The lookup instance.
* @param binaryRepresentation The binary representation.
* @return The defined class.
* @throws IllegalAccessException If the definition implies an illegal access.
*/
Class defineClass(Object lookup, byte[] binaryRepresentation) throws IllegalAccessException;
}
}
}
/**
* A class injector that uses {@code sun.misc.Unsafe} or {@code jdk.internal.misc.Unsafe} to inject classes.
*/
@HashCodeAndEqualsPlugin.Enhance
class UsingUnsafe extends AbstractBase {
/**
* If this property is set, Byte Buddy does not make use of any {@code Unsafe} class.
*/
public static final String SAFE_PROPERTY = "net.bytebuddy.safe";
/**
* The dispatcher to use.
*/
private static final Dispatcher.Initializable DISPATCHER = doPrivileged(Dispatcher.CreationAction.INSTANCE);
/**
* A proxy for {@code java.lang.System} to access the security manager if available.
*/
private static final System SYSTEM = doPrivileged(JavaDispatcher.of(System.class));
/**
* The {@code java.lang.SecurityManager#checkPermission} method or {@code null} if not available.
*/
private static final Method CHECK_PERMISSION = doPrivileged(new GetMethodAction("java.lang.SecurityManager",
"checkPermission",
Permission.class));
/**
* A lock for the bootstrap loader when injecting.
*/
private static final Object BOOTSTRAP_LOADER_LOCK = new Object();
/**
* The class loader to inject classes into or {@code null} for the bootstrap loader.
*/
@MaybeNull
@HashCodeAndEqualsPlugin.ValueHandling(HashCodeAndEqualsPlugin.ValueHandling.Sort.REVERSE_NULLABILITY)
private final ClassLoader classLoader;
/**
* The protection domain to use or {@code null} for no protection domain.
*/
@MaybeNull
@HashCodeAndEqualsPlugin.ValueHandling(HashCodeAndEqualsPlugin.ValueHandling.Sort.REVERSE_NULLABILITY)
private final ProtectionDomain protectionDomain;
/**
* The dispatcher to use.
*/
private final Dispatcher.Initializable dispatcher;
/**
* Creates a new unsafe injector for the given class loader with a default protection domain.
*
* @param classLoader The class loader to inject classes into or {@code null} for the bootstrap loader.
*/
public UsingUnsafe(@MaybeNull ClassLoader classLoader) {
this(classLoader, ClassLoadingStrategy.NO_PROTECTION_DOMAIN);
}
/**
* Creates a new unsafe injector for the given class loader with a default protection domain.
*
* @param classLoader The class loader to inject classes into or {@code null} for the bootstrap loader.
* @param protectionDomain The protection domain to use or {@code null} for no protection domain.
*/
public UsingUnsafe(@MaybeNull ClassLoader classLoader, @MaybeNull ProtectionDomain protectionDomain) {
this(classLoader, protectionDomain, DISPATCHER);
}
/**
* Creates a new unsafe injector for the given class loader with a default protection domain.
*
* @param classLoader The class loader to inject classes into or {@code null} for the bootstrap loader.
* @param protectionDomain The protection domain to use or {@code null} for no protection domain.
* @param dispatcher The dispatcher to use.
*/
protected UsingUnsafe(@MaybeNull ClassLoader classLoader, @MaybeNull ProtectionDomain protectionDomain, Dispatcher.Initializable dispatcher) {
this.classLoader = classLoader;
this.protectionDomain = protectionDomain;
this.dispatcher = dispatcher;
}
/**
* A proxy for {@code java.security.AccessController#doPrivileged} that is activated if available.
*
* @param action The action to execute from a privileged context.
* @param The type of the action's resolved value.
* @return The action's resolved value.
*/
@AccessControllerPlugin.Enhance
private static T doPrivileged(PrivilegedAction action) {
return action.run();
}
/**
* {@inheritDoc}
*/
public boolean isAlive() {
return dispatcher.isAvailable();
}
/**
* {@inheritDoc}
*/
public Map> injectRaw(Map types) {
Dispatcher dispatcher = this.dispatcher.initialize();
Map> result = new HashMap>();
synchronized (classLoader == null
? BOOTSTRAP_LOADER_LOCK
: classLoader) {
for (Map.Entry entry : types.entrySet()) {
try {
result.put(entry.getKey(), Class.forName(entry.getKey(), false, classLoader));
} catch (ClassNotFoundException ignored) {
result.put(entry.getKey(), dispatcher.defineClass(classLoader, entry.getKey(), entry.getValue(), protectionDomain));
}
}
}
return result;
}
/**
* Checks if unsafe class injection is available on the current VM.
*
* @return {@code true} if unsafe class injection is available on the current VM.
*/
public static boolean isAvailable() {
return DISPATCHER.isAvailable();
}
/**
* Returns an unsafe class injector for the system class loader.
*
* @return A class injector for the system class loader.
*/
public static ClassInjector ofSystemLoader() {
return new UsingUnsafe(ClassLoader.getSystemClassLoader());
}
/**
* Returns an unsafe class injector for the platform class loader. For VMs of version 8 or older,
* the extension class loader is represented instead.
*
* @return A class injector for the platform class loader.
*/
public static ClassInjector ofPlatformLoader() {
return new UsingUnsafe(ClassLoader.getSystemClassLoader().getParent());
}
/**
* Returns an unsafe class injector for the boot class loader.
*
* @return A class injector for the boot loader.
*/
public static ClassInjector ofBootLoader() {
return new UsingUnsafe(ClassLoadingStrategy.BOOTSTRAP_LOADER);
}
/**
* A dispatcher for using {@code sun.misc.Unsafe} or {@code jdk.internal.misc.Unsafe}.
*/
protected interface Dispatcher {
/**
* Defines a class.
*
* @param classLoader The class loader to inject the class into.
* @param name The type's name.
* @param binaryRepresentation The type's binary representation.
* @param protectionDomain The type's protection domain.
* @return The defined class.
*/
Class defineClass(@MaybeNull ClassLoader classLoader,
String name,
byte[] binaryRepresentation,
@MaybeNull ProtectionDomain protectionDomain);
/**
* A class injection dispatcher that is not yet initialized.
*/
interface Initializable {
/**
* Checks if unsafe class injection is available on the current VM.
*
* @return {@code true} if unsafe class injection is available.
*/
boolean isAvailable();
/**
* Initializes the dispatcher.
*
* @return The initialized dispatcher.
*/
Dispatcher initialize();
}
/**
* A privileged action for creating a dispatcher.
*/
enum CreationAction implements PrivilegedAction {
/**
* The singleton instance.
*/
INSTANCE;
/**
* {@inheritDoc}
*/
@SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "Exception should not be rethrown but trigger a fallback.")
public Initializable run() {
if (Boolean.getBoolean(SAFE_PROPERTY)) {
return new Unavailable("Use of Unsafe was disabled by system property");
}
try {
Class unsafeType = Class.forName("sun.misc.Unsafe");
Field theUnsafe = unsafeType.getDeclaredField("theUnsafe");
theUnsafe.setAccessible(true);
Object unsafe = theUnsafe.get(null);
try {
Method defineClass = unsafeType.getMethod("defineClass",
String.class,
byte[].class,
int.class,
int.class,
ClassLoader.class,
ProtectionDomain.class);
defineClass.setAccessible(true);
return new Enabled(unsafe, defineClass);
} catch (Exception exception) {
try {
Field override;
try {
override = AccessibleObject.class.getDeclaredField("override");
} catch (NoSuchFieldException ignored) {
// Since Java 12, the override field is hidden from the reflection API. To circumvent this, we
// create a mirror class of AccessibleObject that defines the same fields and has the same field
// layout such that the override field will receive the same class offset. Doing so, we can write to
// the offset location and still set a value to it, despite it being hidden from the reflection API.
override = new ByteBuddy()
.redefine(AccessibleObject.class)
.name("net.bytebuddy.mirror." + AccessibleObject.class.getSimpleName())
.noNestMate()
.visit(new MemberRemoval().stripInvokables(any()))
.make()
.load(AccessibleObject.class.getClassLoader(), ClassLoadingStrategy.Default.WRAPPER)
.getLoaded()
.getDeclaredField("override");
}
long offset = (Long) unsafeType
.getMethod("objectFieldOffset", Field.class)
.invoke(unsafe, override);
Method putBoolean = unsafeType.getMethod("putBoolean", Object.class, long.class, boolean.class);
Class internalUnsafe = Class.forName("jdk.internal.misc.Unsafe");
Field theUnsafeInternal = internalUnsafe.getDeclaredField("theUnsafe");
putBoolean.invoke(unsafe, theUnsafeInternal, offset, true);
Method defineClassInternal = internalUnsafe.getMethod("defineClass",
String.class,
byte[].class,
int.class,
int.class,
ClassLoader.class,
ProtectionDomain.class);
putBoolean.invoke(unsafe, defineClassInternal, offset, true);
return new Enabled(theUnsafeInternal.get(null), defineClassInternal);
} catch (Exception ignored) {
throw exception;
}
}
} catch (Exception exception) {
return new Unavailable(exception.getMessage());
}
}
}
/**
* An enabled dispatcher.
*/
@HashCodeAndEqualsPlugin.Enhance
class Enabled implements Dispatcher, Initializable {
/**
* An instance of {@code sun.misc.Unsafe} or {@code jdk.internal.misc.Unsafe}.
*/
private final Object unsafe;
/**
* The {@code sun.misc.Unsafe#defineClass} or {@code jdk.internal.misc.Unsafe#defineClass} method.
*/
private final Method defineClass;
/**
* Creates an enabled dispatcher.
*
* @param unsafe An instance of {@code sun.misc.Unsafe} or {@code jdk.internal.misc.Unsafe}.
* @param defineClass The {@code sun.misc.Unsafe#defineClass} or {@code jdk.internal.misc.Unsafe#defineClass} method.
*/
protected Enabled(Object unsafe, Method defineClass) {
this.unsafe = unsafe;
this.defineClass = defineClass;
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return true;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
Object securityManager = SYSTEM.getSecurityManager();
if (securityManager != null) {
try {
CHECK_PERMISSION.invoke(securityManager, SUPPRESS_ACCESS_CHECKS);
} catch (InvocationTargetException exception) {
return new Unavailable(exception.getTargetException().getMessage());
} catch (Exception exception) {
return new Unavailable(exception.getMessage());
}
}
return this;
}
/**
* {@inheritDoc}
*/
public Class defineClass(@MaybeNull ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
try {
return (Class) defineClass.invoke(unsafe,
name,
binaryRepresentation,
0,
binaryRepresentation.length,
classLoader,
protectionDomain);
} catch (IllegalAccessException exception) {
throw new IllegalStateException(exception);
} catch (InvocationTargetException exception) {
throw new IllegalStateException(exception.getTargetException());
}
}
}
/**
* A disabled dispatcher.
*/
@HashCodeAndEqualsPlugin.Enhance
class Unavailable implements Dispatcher, Initializable {
/**
* The reason why this dispatcher is not available.
*/
private final String message;
/**
* Creates a disabled dispatcher.
*
* @param message The reason why this dispatcher is not available.
*/
protected Unavailable(String message) {
this.message = message;
}
/**
* {@inheritDoc}
*/
public boolean isAvailable() {
return false;
}
/**
* {@inheritDoc}
*/
public Dispatcher initialize() {
throw new UnsupportedOperationException("Could not access Unsafe class: " + message);
}
/**
* {@inheritDoc}
*/
public Class defineClass(@MaybeNull ClassLoader classLoader, String name, byte[] binaryRepresentation, @MaybeNull ProtectionDomain protectionDomain) {
throw new UnsupportedOperationException("Could not access Unsafe class: " + message);
}
}
}
/**
* A factory for creating a {@link ClassInjector} that uses {@code sun.misc.Unsafe} if available but attempts a fallback
* to using {@code jdk.internal.misc.Unsafe} if the {@code jdk.internal} module is not resolved or unavailable.
*/
@HashCodeAndEqualsPlugin.Enhance
public static class Factory {
/**
* The dispatcher to use.
*/
private final Dispatcher.Initializable dispatcher;
/**
* Creates a new factory for an unsafe class injector that uses Byte Buddy's privileges to
* accessing {@code jdk.internal.misc.Unsafe} if available.
*/
public Factory() {
this(AccessResolver.Default.INSTANCE);
}
/**
* Creates a new factory for an unsafe class injector.
*
* @param accessResolver The access resolver to use.
*/
@SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "Exception should not be rethrown but trigger a fallback.")
public Factory(AccessResolver accessResolver) {
Dispatcher.Initializable dispatcher;
if (DISPATCHER.isAvailable()) {
dispatcher = DISPATCHER;
} else {
try {
Class unsafeType = Class.forName("jdk.internal.misc.Unsafe");
Field theUnsafe = unsafeType.getDeclaredField("theUnsafe");
accessResolver.apply(theUnsafe);
Object unsafe = theUnsafe.get(null);
Method defineClass = unsafeType.getMethod("defineClass",
String.class,
byte[].class,
int.class,
int.class,
ClassLoader.class,
ProtectionDomain.class);
accessResolver.apply(defineClass);
dispatcher = new Dispatcher.Enabled(unsafe, defineClass);
} catch (Exception exception) {
dispatcher = new Dispatcher.Unavailable(exception.getMessage());
}
}
this.dispatcher = dispatcher;
}
/**
* Creates a new factory.
*
* @param dispatcher The dispatcher to use.
*/
protected Factory(Dispatcher.Initializable dispatcher) {
this.dispatcher = dispatcher;
}
/**
* Resolves an injection strategy that uses unsafe injection if available and also attempts to open and use
* {@code jdk.internal.misc.Unsafe} as a fallback. This method generates a new class and module for opening the
* internal package to avoid its exposure to any non-trusted code.
*
* @param instrumentation The instrumentation instance to use for opening the internal package if required.
* @return An appropriate injection strategy.
*/
public static Factory resolve(Instrumentation instrumentation) {
return resolve(instrumentation, false);
}
/**
* Resolves an injection strategy that uses unsafe injection if available and also attempts to open and use
* {@code jdk.internal.misc.Unsafe} as a fallback.
*
* @param instrumentation The instrumentation instance to use for opening the internal package if required.
* @param local {@code false} if a new class should in a separated class loader and module should be created for
* opening the {@code jdk.internal.misc} package. This way, the internal package is not exposed to any
* other classes within this class's module.
* @return An appropriate injection strategy.
*/
@SuppressFBWarnings(
value = {"REC_CATCH_EXCEPTION", "NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"},
justification = "Exception intends to trigger disabled injection strategy. Modules are assumed if module system is supported.")
public static Factory resolve(Instrumentation instrumentation, boolean local) {
if (ClassInjector.UsingUnsafe.isAvailable() || !JavaModule.isSupported()) {
return new Factory();
} else {
try {
Class type = Class.forName("jdk.internal.misc.Unsafe");
PackageDescription packageDescription = new PackageDescription.ForLoadedPackage(type.getPackage());
JavaModule source = JavaModule.ofType(type), target = JavaModule.ofType(ClassInjector.UsingUnsafe.class);
if (source.isOpened(packageDescription, target)) {
return new Factory();
} else if (local) {
JavaModule module = JavaModule.ofType(AccessResolver.Default.class);
UsingInstrumentation.redefineModule(instrumentation,
source,
Collections.singleton(module),
Collections.>emptyMap(),
Collections.singletonMap(packageDescription.getName(), Collections.singleton(module)),
Collections.>emptySet(),
Collections., List>>emptyMap());
return new Factory();
} else {
Class resolver = new ByteBuddy()
.subclass(AccessResolver.class)
.method(named("apply"))
.intercept(MethodCall.invoke(AccessibleObject.class.getMethod("setAccessible", boolean.class))
.onArgument(0)
.with(true))
.make()
.load(AccessResolver.class.getClassLoader(), ClassLoadingStrategy.Default.WRAPPER.with(AccessResolver.class.getProtectionDomain()))
.getLoaded();
JavaModule module = JavaModule.ofType(resolver);
ClassInjector.UsingInstrumentation.redefineModule(instrumentation,
source,
Collections.singleton(module),
Collections.>emptyMap(),
Collections.singletonMap(packageDescription.getName(), Collections.singleton(module)),
Collections.>emptySet(),
Collections., List>>emptyMap());
return new ClassInjector.UsingUnsafe.Factory(resolver.getConstructor().newInstance());
}
} catch (Exception exception) {
return new Factory(new Dispatcher.Unavailable(exception.getMessage()));
}
}
}
/**
* Returns {@code true} if this factory creates a valid dispatcher.
*
* @return {@code true} if this factory creates a valid dispatcher.
*/
public boolean isAvailable() {
return dispatcher.isAvailable();
}
/**
* Creates a new class injector for the given class loader without a {@link ProtectionDomain}.
*
* @param classLoader The class loader to inject into or {@code null} to inject into the bootstrap loader.
* @return An appropriate class injector.
*/
public ClassInjector make(@MaybeNull ClassLoader classLoader) {
return make(classLoader, ClassLoadingStrategy.NO_PROTECTION_DOMAIN);
}
/**
* Creates a new class injector for the given class loader and protection domain.
*
* @param classLoader The class loader to inject into or {@code null} to inject into the bootstrap loader.
* @param protectionDomain The protection domain to apply or {@code null} if no protection domain should be used.
* @return An appropriate class injector.
*/
public ClassInjector make(@MaybeNull ClassLoader classLoader, @MaybeNull ProtectionDomain protectionDomain) {
return new UsingUnsafe(classLoader, protectionDomain, dispatcher);
}
/**
* An access resolver that invokes {@link AccessibleObject#setAccessible(boolean)} to {@code true} in a given privilege scope.
*/
public interface AccessResolver {
/**
* Applies this access resolver.
*
* @param accessibleObject The accessible object to make accessible.
*/
void apply(AccessibleObject accessibleObject);
/**
* A default access resolver that uses Byte Buddy's privilege scope.
*/
enum Default implements AccessResolver {
/**
* The singleton instance.
*/
INSTANCE;
/**
* {@inheritDoc}
*/
public void apply(AccessibleObject accessibleObject) {
accessibleObject.setAccessible(true);
}
}
}
}
/**
* A proxy of {@code java.lang.System}.
*/
@JavaDispatcher.Proxied("java.lang.System")
protected interface System {
/**
* Returns the current security manager or {@code null} if not available.
*
* @return The current security manager or {@code null} if not available.
*/
@MaybeNull
@JavaDispatcher.IsStatic
@JavaDispatcher.Defaults
Object getSecurityManager();
}
}
/**
* A class injector using a {@link java.lang.instrument.Instrumentation} to append to either the boot classpath
* or the system class path.
*/
@HashCodeAndEqualsPlugin.Enhance
class UsingInstrumentation extends AbstractBase {
/**
* The jar file name extension.
*/
private static final String JAR = "jar";
/**
* The class file extension.
*/
private static final String CLASS_FILE_EXTENSION = ".class";
/**
* A dispatcher for interacting with the instrumentation API.
*/
private static final Dispatcher DISPATCHER = doPrivileged(JavaDispatcher.of(Dispatcher.class));
/**
* The instrumentation to use for appending to the class path or the boot path.
*/
private final Instrumentation instrumentation;
/**
* A representation of the target path to which classes are to be appended.
*/
private final Target target;
/**
* The folder to be used for storing jar files.
*/
private final File folder;
/**
* A random string generator for creating file names.
*/
private final RandomString randomString;
/**
* Creates an instrumentation-based class injector.
*
* @param folder The folder to be used for storing jar files.
* @param target A representation of the target path to which classes are to be appended.
* @param instrumentation The instrumentation to use for appending to the class path or the boot path.
* @param randomString The random string generator to use.
*/
protected UsingInstrumentation(File folder,
Target target,
Instrumentation instrumentation,
RandomString randomString) {
this.folder = folder;
this.target = target;
this.instrumentation = instrumentation;
this.randomString = randomString;
}
/**
* A proxy for {@code java.security.AccessController#doPrivileged} that is activated if available.
*
* @param action The action to execute from a privileged context.
* @param The type of the action's resolved value.
* @return The action's resolved value.
*/
@AccessControllerPlugin.Enhance
private static T doPrivileged(PrivilegedAction action) {
return action.run();
}
/**
* Modifies a module's properties using {@link Instrumentation}.
*
* @param instrumentation The {@link Instrumentation} instance to use for applying the modification.
* @param target The target module that should be modified.
* @param reads A set of additional modules this module should read.
* @param exports A map of packages to export to a set of modules.
* @param opens A map of packages to open to a set of modules.
* @param uses A set of provider interfaces to use by this module.
* @param provides A map of provider interfaces to provide by this module mapped to the provider implementations.
*/
public static void redefineModule(Instrumentation instrumentation,
JavaModule target,
Set reads,
Map> exports,
Map> opens,
Set> uses,
Map, List>> provides) {
if (!DISPATCHER.isModifiableModule(instrumentation, target.unwrap())) {
throw new IllegalArgumentException("Cannot modify module: " + target);
}
Set © 2015 - 2024 Weber Informatics LLC | Privacy Policy