Class ClassReloadingStrategy
- java.lang.Object
-
- net.bytebuddy.dynamic.loading.ClassReloadingStrategy
-
- All Implemented Interfaces:
ClassLoadingStrategy<ClassLoader>
@Enhance public class ClassReloadingStrategy extends Object implements ClassLoadingStrategy<ClassLoader>
The class reloading strategy allows to redefine loaded
Class
es. Note that this strategy will always attempt to load an existing class prior to its redefinition, even if this class is not yet loaded.Note: In order to redefine any type, neither its name or its modifiers must be changed. Furthermore, no fields or methods must be removed or added. This makes this strategy generally incompatible to applying it to a rebased class definition as by
ByteBuddy.rebase(Class)
which copies the original method implementations to additional methods. Furthermore, even theByteBuddy.redefine(Class)
adds a method if the original class contains an explicit class initializer. For these reasons, it is not recommended to use thisClassLoadingStrategy
with arbitrary classes.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interface
ClassReloadingStrategy.BootstrapInjection
A strategy to apply for injecting classes into the bootstrap class loader.protected static interface
ClassReloadingStrategy.Dispatcher
A dispatcher to interact with the instrumentation API.static class
ClassReloadingStrategy.Strategy
A strategy which performs the actual redefinition of aClass
.-
Nested classes/interfaces inherited from interface net.bytebuddy.dynamic.loading.ClassLoadingStrategy
ClassLoadingStrategy.Configurable<S extends ClassLoader>, ClassLoadingStrategy.Default, ClassLoadingStrategy.ForBootstrapInjection, ClassLoadingStrategy.ForUnsafeInjection, ClassLoadingStrategy.UsingLookup
-
-
Field Summary
Fields Modifier and Type Field Description protected static ClassReloadingStrategy.Dispatcher
DISPATCHER
A dispatcher to use with some methods of theInstrumentation
API.-
Fields inherited from interface net.bytebuddy.dynamic.loading.ClassLoadingStrategy
BOOTSTRAP_LOADER, NO_PROTECTION_DOMAIN
-
-
Constructor Summary
Constructors Modifier Constructor Description ClassReloadingStrategy(Instrumentation instrumentation, ClassReloadingStrategy.Strategy strategy)
Creates a class reloading strategy for the given instrumentation using an explicit transformation strategy which is represented by anClassReloadingStrategy.Strategy
.protected
ClassReloadingStrategy(Instrumentation instrumentation, ClassReloadingStrategy.Strategy strategy, ClassReloadingStrategy.BootstrapInjection bootstrapInjection, Map<String,Class<?>> preregisteredTypes)
Creates a new class reloading strategy.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassReloadingStrategy
enableBootstrapInjection(File folder)
Enables bootstrap injection for this class reloading strategy.static ClassReloadingStrategy
fromInstalledAgent()
Obtains aClassReloadingStrategy
from an installed Byte Buddy agent.static ClassReloadingStrategy
fromInstalledAgent(ClassReloadingStrategy.Strategy strategy)
Obtains aClassReloadingStrategy
from an installed Byte Buddy agent.Map<TypeDescription,Class<?>>
load(ClassLoader classLoader, Map<TypeDescription,byte[]> types)
Loads a given collection of classes given their binary representation.static ClassReloadingStrategy
of(Instrumentation instrumentation)
Creates a class reloading strategy for the given instrumentation.ClassReloadingStrategy
preregistered(Class<?>... type)
Registers a type to be explicitly available without explicit lookup.ClassReloadingStrategy
reset(Class<?>... type)
Resets all classes to their original definition while using the first type's class loader as a class file locator.ClassReloadingStrategy
reset(ClassFileLocator classFileLocator, Class<?>... type)
Resets all classes to their original definition.
-
-
-
Field Detail
-
DISPATCHER
protected static final ClassReloadingStrategy.Dispatcher DISPATCHER
A dispatcher to use with some methods of theInstrumentation
API.
-
-
Constructor Detail
-
ClassReloadingStrategy
public ClassReloadingStrategy(Instrumentation instrumentation, ClassReloadingStrategy.Strategy strategy)
Creates a class reloading strategy for the given instrumentation using an explicit transformation strategy which is represented by anClassReloadingStrategy.Strategy
. The given instrumentation must support the strategy's transformation type.- Parameters:
instrumentation
- The instrumentation to be used by this reloading strategy.strategy
- A strategy which performs the actual redefinition of aClass
.
-
ClassReloadingStrategy
protected ClassReloadingStrategy(Instrumentation instrumentation, ClassReloadingStrategy.Strategy strategy, ClassReloadingStrategy.BootstrapInjection bootstrapInjection, Map<String,Class<?>> preregisteredTypes)
Creates a new class reloading strategy.- Parameters:
instrumentation
- The instrumentation to be used by this reloading strategy.strategy
- An strategy which performs the actual redefinition of aClass
.bootstrapInjection
- The bootstrap class loader injection strategy to use.preregisteredTypes
- The preregistered types of this instance.
-
-
Method Detail
-
of
public static ClassReloadingStrategy of(Instrumentation instrumentation)
Creates a class reloading strategy for the given instrumentation. The given instrumentation must either supportInstrumentation.isRedefineClassesSupported()
orInstrumentation.isRetransformClassesSupported()
. If both modes are supported, classes will be transformed using a class retransformation.- Parameters:
instrumentation
- The instrumentation to be used by this reloading strategy.- Returns:
- A suitable class reloading strategy.
-
fromInstalledAgent
public static ClassReloadingStrategy fromInstalledAgent()
Obtains a
ClassReloadingStrategy
from an installed Byte Buddy agent. This agent must be installed either by adding thebyte-buddy-agent.jar
when starting up the JVM byjava -javaagent:byte-buddy-agent.jar -jar app.jar
ByteBuddyAgent
within thebyte-buddy-agent
module. The strategy is determined by the agent's support for redefinition where are retransformation is preferred over a redefinition.- Returns:
- A class reloading strategy which uses the Byte Buddy agent's
Instrumentation
.
-
fromInstalledAgent
public static ClassReloadingStrategy fromInstalledAgent(ClassReloadingStrategy.Strategy strategy)
Obtains a
ClassReloadingStrategy
from an installed Byte Buddy agent. This agent must be installed either by adding thebyte-buddy-agent.jar
when starting up the JVM byjava -javaagent:byte-buddy-agent.jar -jar app.jar
ByteBuddyAgent
within thebyte-buddy-agent
module.- Parameters:
strategy
- The strategy to use.- Returns:
- A class reloading strategy which uses the Byte Buddy agent's
Instrumentation
.
-
load
public Map<TypeDescription,Class<?>> load(ClassLoader classLoader, Map<TypeDescription,byte[]> types)
Loads a given collection of classes given their binary representation.- Specified by:
load
in interfaceClassLoadingStrategy<ClassLoader>
- Parameters:
classLoader
- The class loader to used for loading the classes.types
- Byte array representations of the types to be loaded mapped by their descriptions, where an iteration order defines an order in which they are supposed to be loaded, if relevant.- Returns:
- A collection of the loaded classes which will be initialized in the iteration order of the returned collection.
-
reset
public ClassReloadingStrategy reset(Class<?>... type) throws IOException
Resets all classes to their original definition while using the first type's class loader as a class file locator.- Parameters:
type
- The types to reset.- Returns:
- This class reloading strategy.
- Throws:
IOException
- If a class file locator causes an IO exception.
-
reset
public ClassReloadingStrategy reset(ClassFileLocator classFileLocator, Class<?>... type) throws IOException
Resets all classes to their original definition.- Parameters:
classFileLocator
- The class file locator to use.type
- The types to reset.- Returns:
- This class reloading strategy.
- Throws:
IOException
- If a class file locator causes an IO exception.
-
enableBootstrapInjection
public ClassReloadingStrategy enableBootstrapInjection(File folder)
Enables bootstrap injection for this class reloading strategy.- Parameters:
folder
- The folder to save jar files in that are appended to the bootstrap class path.- Returns:
- A class reloading strategy with bootstrap injection enabled.
-
preregistered
public ClassReloadingStrategy preregistered(Class<?>... type)
Registers a type to be explicitly available without explicit lookup.- Parameters:
type
- The loaded types that are explicitly available.- Returns:
- This class reloading strategy with the given types being explicitly available.
-
-