Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do you change the CLASSPATH within Java?

How do you change the CLASSPATH of a Java process from within the Java process?


Before you ask me "Why would you want to do that?" I'll explain it shortly.

When you have a Clojure REPL running it is common to need more jars in your CLASSPATH to load a Clojure source file, and I'd like to do it without having to restart Clojure itself (which is not really an option when using it on Slime on Emacs).

That's the reason but I don't want this question tagged as some-weird-language some-weird-editor and be disregarded by the majority of Java developers that may have the answer.

like image 335
pupeno Avatar asked Oct 31 '08 08:10

pupeno


People also ask

How do I find my Java classpath in Windows?

Now to check the value of Java classpath in windows type "echo %CLASSPATH" in your DOS command prompt and it will show you the value of the directory which is included in CLASSPATH.

What is classpath in Java with example?

The CLASSPATH variable is an environment variable, meaning it's part of the operating system (e.g., Windows). It contains the list of directories. These directories contain any class you created, plus the delivered Java class file, called the Java Archive (JAR).

What is the default Java classpath?

From The Java™ tutorials: PATH and CLASSPATH: The default value of the class path is ".", meaning that only the current directory is searched. Specifying either the CLASSPATH variable or the -cp command line switch overrides this value.


2 Answers

Update Q4 2017: as commented below by vda8888, in Java 9, the System java.lang.ClassLoader is no longer a java.net.URLClassLoader.

See "Java 9 Migration Guide: The Seven Most Common Challenges"

The class loading strategy that I just described is implemented in a new type and in Java 9 the application class loader is of that type.
That means it is not a URLClassLoader anymore, so the occasional (URLClassLoader) getClass().getClassLoader() or (URLClassLoader) ClassLoader.getSystemClassLoader() sequences will no longer execute.

java.lang.ModuleLayer would be an alternative approach used in order to influence the modulepath (instead of the classpath). See for instance "Java 9 modules - JPMS basics".


For Java 8 or below:

Some general comments:

you cannot (in a portable way that's guaranteed to work, see below) change the system classpath. Instead, you need to define a new ClassLoader.

ClassLoaders work in a hierarchical manner... so any class that makes a static reference to class X needs to be loaded in the same ClassLoader as X, or in a child ClassLoader. You can NOT use any custom ClassLoader to make code loaded by the system ClassLoader link properly, if it wouldn't have done so before. So you need to arrange for your main application code to be run in the custom ClassLoader in addition to the extra code that you locate.
(That being said, cracked-all mentions in the comments this example of extending the URLClassLoader)

And you might consider not writing your own ClassLoader, but just use URLClassLoader instead. Create a URLClassLoader with a url that are not in the parent classloaders url's.

URL[] url={new URL("file://foo")}; URLClassLoader loader = new URLClassLoader(url); 

A more complete solution would be:

ClassLoader currentThreadClassLoader  = Thread.currentThread().getContextClassLoader();  // Add the conf dir to the classpath // Chain the current thread classloader URLClassLoader urlClassLoader  = new URLClassLoader(new URL[]{new File("mtFile").toURL()},                       currentThreadClassLoader);  // Replace the thread classloader - assumes // you have permissions to do so Thread.currentThread().setContextClassLoader(urlClassLoader); 

If you assume the JVMs system classloader is a URLClassLoader (which may not be true for all JVMs), you can use reflection as well to actually modify the system classpath... (but that's a hack;)):

public void addURL(URL url) throws Exception {   URLClassLoader classLoader          = (URLClassLoader) ClassLoader.getSystemClassLoader();   Class clazz= URLClassLoader.class;    // Use reflection   Method method= clazz.getDeclaredMethod("addURL", new Class[] { URL.class });   method.setAccessible(true);   method.invoke(classLoader, new Object[] { url }); }  addURL(new File("conf").toURL());  // This should work now! Thread.currentThread().getContextClassLoader().getResourceAsStream("context.xml"); 
like image 127
VonC Avatar answered Sep 23 '22 11:09

VonC


I don't believe you can - the right thing to do (I believe) is create a new classloader with the new path. Alternatively, you could write your own classloader which allows you to change the classpath (for that loader) dynamically.

like image 39
Jon Skeet Avatar answered Sep 22 '22 11:09

Jon Skeet