Package org.apache.velocity.runtime.resource.loader

Class 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 Detail

      • entryDirectory

        private java.util.Map entryDirectory
        Maps entries to the parent JAR File Key = the entry *excluding* plain directories Value = the JAR URL

      • jarfiles

        private java.util.Map jarfiles
        Maps JAR URLs to the actual JAR Key = the JAR URL Value = the JAR

    • Constructor Detail

      • JarResourceLoader

        public JarResourceLoader()

    • Method Detail

      • init

        public void init​(org.apache.commons.collections.ExtendedProperties configuration)
        Called by Velocity to initialize the loader
        Specified by:
        init in class ResourceLoader
        Parameters:
        configuration -

      • loadJar

        private void loadJar​(java.lang.String path)

      • closeJar

        private void closeJar​(java.lang.String path)
        Closes a Jar file and set its URLConnection to null.

      • addEntries

        private void addEntries​(java.util.Hashtable entries)
        Copy all the entries into the entryDirectory It will overwrite any duplicate keys.

      • getResourceStream

        public java.io.InputStream getResourceStream​(java.lang.String source)
                                      throws ResourceNotFoundException
        Get an InputStream so that the Runtime can build a template with it.
        Specified by:
        getResourceStream in class ResourceLoader
        Parameters:
        source - name of template to get
        Returns:
        InputStream containing the template
        Throws:
        ResourceNotFoundException - if template not found in the file template path.