spring-framework / org.springframework.instrument.classloading

Package org.springframework.instrument.classloading

Types

InstrumentationLoadTimeWeaver

open class InstrumentationLoadTimeWeaver : LoadTimeWeaver

LoadTimeWeaver relying on VM Instrumentation.

Start the JVM specifying the Java agent to be used, like as follows:

-javaagent:path/to/org.springframework.instrument.jar

where org.springframework.instrument.jar is a JAR file containing the InstrumentationSavingAgent class, as shipped with Spring.

In Eclipse, for example, set the "Run configuration"'s JVM args to be of the form:

-javaagent:${project_loc}/lib/org.springframework.instrument.jar

ReflectiveLoadTimeWeaver

open class ReflectiveLoadTimeWeaver : LoadTimeWeaver

LoadTimeWeaver which uses reflection to delegate to an underlying ClassLoader with well-known transformation hooks. The underlying ClassLoader is expected to support the following weaving methods (as defined in the LoadTimeWeaver interface):

  • public void addTransformer(java.lang.instrument.ClassFileTransformer): for registering the given ClassFileTransformer on this ClassLoader
  • public ClassLoader getThrowawayClassLoader(): for obtaining a throwaway class loader for this ClassLoader (optional; ReflectiveLoadTimeWeaver will fall back to a SimpleThrowawayClassLoader if that method isn't available)

Please note that the above methods must reside in a class that is publicly accessible, although the class itself does not have to be visible to the application's class loader.

The reflective nature of this LoadTimeWeaver is particularly useful when the underlying ClassLoader implementation is loaded in a different class loader itself (such as the application server's class loader which is not visible to the web application). There is no direct API dependency between this LoadTimeWeaver adapter and the underlying ClassLoader, just a 'loose' method contract.

This is the LoadTimeWeaver to use e.g. with the Resin application server version 3.1+.

ResourceOverridingShadowingClassLoader

open class ResourceOverridingShadowingClassLoader : ShadowingClassLoader

Subclass of ShadowingClassLoader that overrides attempts to locate certain files.

ShadowingClassLoader

open class ShadowingClassLoader : DecoratingClassLoader

ClassLoader decorator that shadows an enclosing ClassLoader, applying registered transformers to all affected classes.

SimpleLoadTimeWeaver

open class SimpleLoadTimeWeaver : LoadTimeWeaver

LoadTimeWeaver that builds and exposes a SimpleInstrumentableClassLoader.

Mainly intended for testing environments, where it is sufficient to perform all class transformation on a newly created ClassLoader instance.

WeavingTransformer

open class WeavingTransformer

ClassFileTransformer-based weaver, allowing for a list of transformers to be applied on a class byte array. Normally used inside class loaders.

Note: This class is deliberately implemented for minimal external dependencies, since it is included in weaver jars (to be deployed into application servers).