Class JarResourceLoader

java.lang.Object
org.apache.velocity.runtime.resource.loader.ResourceLoader
org.apache.velocity.runtime.resource.loader.JarResourceLoader

public class JarResourceLoader extends ResourceLoader

ResourceLoader to load templates from multiple Jar files.

The configuration of the JarResourceLoader is straightforward - You simply add the JarResourceLoader to the configuration via

    resource.loader = jar
    jar.resource.loader.class = org.apache.velocity.runtime.resource.loader.JarResourceLoader
    jar.resource.loader.path = list of JAR <URL>s
 

So for example, if you had a jar file on your local filesystem, you could simply do

    jar.resource.loader.path = jar:file:/opt/myfiles/jar1.jar
    

Note that jar specification for the .path configuration property conforms to the same rules for the java.net.JarUrlConnection class.

For a working example, see the unit test case, org.apache.velocity.test.MultiLoaderTestCase class

Version:
$Id: JarResourceLoader.java 691884 2008-09-04 06:46:51Z nbubna $
  • Field Details

    • entryDirectory

      private Map entryDirectory
      Maps entries to the parent JAR File Key = the entry *excluding* plain directories Value = the JAR URL
    • jarfiles

      private Map jarfiles
      Maps JAR URLs to the actual JAR Key = the JAR URL Value = the JAR
  • Constructor Details

    • JarResourceLoader

      public JarResourceLoader()
  • Method Details