org.springframework.instrument.classloading.tomcat

Class TomcatInstrumentableClassLoader

java.lang.Object

java.lang.ClassLoader

org.apache.catalina.loader.WebappClassLoader

org.springframework.instrument.classloading.tomcat.TomcatInstrumentableClassLoader

public class TomcatInstrumentableClassLoader
extends WebappClassLoader

Extension of Tomcat's default class loader which adds instrumentation to loaded classes without the need to use a VM-wide agent.

To be registered using a Loader tag in Tomcat's Context definition in the server.xml file, with the Spring-provided "spring-instrument-tomcat.jar" file deployed into Tomcat's "lib" directory. The required configuration tag looks as follows:

<Loader loaderClass="org.springframework.instrument.classloading.tomcat.TomcatInstrumentableClassLoader"/>

Typically used in combination with a ReflectiveLoadTimeWeaver defined in the Spring application context. The addTransformer and getThrowawayClassLoader methods mirror the corresponding methods in the LoadTimeWeaver interface, as expected by ReflectiveLoadTimeWeaver.

NOTE: Requires Apache Tomcat version 6.0 or higher, as of Spring 4.0. This class is not intended to work on Tomcat 8.0+; please rely on Tomcat's own InstrumentableClassLoader facility instead, as autodetected by Spring's TomcatLoadTimeWeaver.

Since:

2.0

Author:

Costin Leau, Juergen Hoeller

See Also:

addTransformer(java.lang.instrument.ClassFileTransformer), getThrowawayClassLoader(), ReflectiveLoadTimeWeaver, TomcatLoadTimeWeaver

Constructor Summary

Constructors

Constructor and Description
TomcatInstrumentableClassLoader() Create a new TomcatInstrumentableClassLoader using the current context class loader.
TomcatInstrumentableClassLoader(ClassLoader parent) Create a new TomcatInstrumentableClassLoader with the supplied class loader as parent.

Method Summary

Modifier and Type	Method and Description
void	addTransformer(ClassFileTransformer transformer) Delegate for LoadTimeWeaver's addTransformer method.
protected org.apache.catalina.loader.ResourceEntry	findResourceInternal(String name, String path)
protected org.apache.catalina.loader.ResourceEntry	findResourceInternal(String name, String path, boolean manifestRequired)
ClassLoader	getThrowawayClassLoader() Delegate for LoadTimeWeaver's getThrowawayClassLoader method.
String	toString()

Methods inherited from class java.lang.ClassLoader

clearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findClass, findLibrary, findLoadedClass, findResource, findResources, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResource, getResourceAsStream, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, loadClass, loadClass, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSigners

Methods inherited from class java.lang.Object

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

Constructor Detail

TomcatInstrumentableClassLoader

public TomcatInstrumentableClassLoader()

Create a new TomcatInstrumentableClassLoader using the current context class loader.

See Also:

TomcatInstrumentableClassLoader(ClassLoader)

TomcatInstrumentableClassLoader

public TomcatInstrumentableClassLoader(ClassLoader parent)

Create a new TomcatInstrumentableClassLoader with the supplied class loader as parent.

Parameters:

parent - the parent ClassLoader to be used

Method Detail

addTransformer

public void addTransformer(ClassFileTransformer transformer)

Delegate for LoadTimeWeaver's addTransformer method. Typically called through ReflectiveLoadTimeWeaver.

See Also:

LoadTimeWeaver.addTransformer(java.lang.instrument.ClassFileTransformer), ReflectiveLoadTimeWeaver

getThrowawayClassLoader

public ClassLoader getThrowawayClassLoader()

Delegate for LoadTimeWeaver's getThrowawayClassLoader method. Typically called through ReflectiveLoadTimeWeaver.

See Also:

LoadTimeWeaver.getThrowawayClassLoader(), ReflectiveLoadTimeWeaver

findResourceInternal

protected org.apache.catalina.loader.ResourceEntry findResourceInternal(String name,
                                                                        String path)

Overrides:

findResourceInternal in class WebappClassLoader

findResourceInternal

protected org.apache.catalina.loader.ResourceEntry findResourceInternal(String name,
                                                                        String path,
                                                                        boolean manifestRequired)

Overrides:

findResourceInternal in class WebappClassLoader

toString

public String toString()

Overrides:

toString in class Object