views:

230

answers:

1

For debug reasons, and curiosity, I wish to list all classes loaded to a specific class loader.

Seeing as most methods of a class loader are protected, what is the best way to accomplish what I want?

Thanks!

+1  A: 

Instrumentation.getInitiatedClasses(ClassLoader) may do what you want.

According to the docs:

Returns an array of all classes for which loader is an initiating loader.

I'm not sure what "initiating loader" means though. If that does not give the right result try using the getAllLoadedClasses() method and manually filtering by ClassLoader.


How to get an instance of Instrumentation

Only the agent JAR (which is separate from the application JAR) can get an instance of the Instrumentation interface. A simple way to make it available to the application is to create an agent JAR containing one class with a premain method that does nothing but save a reference to the Instrumentation instance in the system properties.

Example agent class:

public class InstrumentHook {

    public static void premain(String agentArgs, Instrumentation inst) {
        if (agentArgs != null) {
            System.getProperties().put(AGENT_ARGS_KEY, agentArgs);
        }
        System.getProperties().put(INSTRUMENTATION_KEY, inst);
    }

    public Instrumentation getInstrumentation() {
        return (Instrumentation) System.getProperties().get(INSTRUMENTATION_KEY);
    }

    // Needn't be a UUID - can be a String or any other object that
    // implements equals().    
    private static final Object AGENT_ARGS_KEY =
        UUID.fromString("887b43f3-c742-4b87-978d-70d2db74e40e");

    private static final Object INSTRUMENTATION_KEY =
        UUID.fromString("214ac54a-60a5-417e-b3b8-772e80a16667");

}

Example manifest:

Manifest-Version: 1.0
Premain-Class: InstrumentHook

The resulting JAR must then be referenced by the application and specified on the command line (with the -javaagent option) when launching the application. It might be loaded twice in different ClassLoaders, but that is not a problem since the system Properties is a per-process singleton.

Example application class

public class Main {
    public static void main(String[] args) {
        Instrumentation inst = InstrumentHook.getInstrumentation();
        for (Class<?> clazz: inst.getAllLoadedClasses()) {
            System.err.println(clazz.getName());
        }
    }
}
finnw
But how to get an Instrumentation instance?
Arne Burmeister
@Arne Burmeister, see the package description: http://java.sun.com/javase/6/docs/api/java/lang/instrument/package-summary.html
finnw
@finnw: so if I get it correctly, I have to write an agent, which contains a method signatured as "public static void premain(String agentArgs, Instrumentation inst);" and then invoke the Instrumentation methods via the inst ref?
Yaneeve
@Yaneeve, yes. Added an example to my answer.
finnw