Keywords: Tomcat | Classpath | External Directory
Abstract: This article provides an in-depth analysis of configuring external directories in Tomcat's classpath for specific web applications. Focusing on the class loading mechanism, it details the use of shared.loader or common.loader properties in catalina.properties, with comparisons to alternative methods. Complete configuration examples and best practices are included to facilitate flexible management of external resource files.
Problem Background and Requirements
In Java web application development, it is often necessary to add external directories to Tomcat's classpath. For instance, a user needs to store locale-specific property files in C:\app_config\java_app, which must be loaded by ResourceBundle during web application startup. The key requirement is to configure this external directory for a single web application only, without global modifications, and avoid placing files in the WEB-INF/classes folder.
Analysis of Tomcat Class Loading Mechanism
Tomcat employs a hierarchical classloader structure, including Bootstrap, System, Common, and Webapp classloaders. The Common classloader is responsible for loading classes shared by Tomcat and all web applications, while the Webapp classloader is dedicated to individual applications. By configuring the shared.loader or common.loader properties, external directories can be added to the Common classloader's search path, making resources accessible to all web applications.
Core Configuration Method
In Tomcat's conf/catalina.properties file, locate the shared.loader or common.loader properties. By default, these may be commented out or empty. For example, to add the external directory C:\app_config\java_app, configure as follows:
shared.loader="C:/app_config/java_app"
# or
common.loader="${catalina.base}/lib","${catalina.base}/lib/*.jar","${catalina.home}/lib","${catalina.home}/lib/*.jar","C:/app_config/java_app"After configuration, restart the Tomcat server for changes to take effect. The ResourceBundle in the PrjPropertilesLocator class will then be able to load property files from this directory.
Comparison with Alternative Configuration Methods
Beyond the above method, finer control can be achieved through Context configuration. For example, define a Loader element in $CATALINA_BASE/conf/Catalina/localhost/APPNAME.xml:
<Context>
<Loader className="org.apache.catalina.loader.VirtualWebappLoader" virtualClasspath="C:/app_config/java_app"/>
</Context>This approach allows custom classpaths for individual applications but requires more complex setup and may have syntax variations across Tomcat versions. In contrast, modifying catalina.properties is simpler and more straightforward.
Practical Considerations
On Windows systems, use forward slashes or double backslashes for paths, such as C:/app_config/java_app or C:\\app_config\\java_app, to avoid escape issues. Additionally, ensure Tomcat has read permissions for the directory and that property files adhere to ResourceBundle naming conventions (e.g., messages_en.properties).
Summary and Recommendations
Modifying the shared.loader or common.loader properties in catalina.properties is the most efficient method for adding external directories to Tomcat's classpath. While this affects all web applications, it suffices for most scenarios. For environments requiring strict isolation, Context configuration can be considered, but attention to version compatibility and maintenance overhead is advised.