org.apache.velocity.runtime.resource.loader

Class ClasspathResourceLoader

public class ClasspathResourceLoader extends ResourceLoader

ClasspathResourceLoader is a simple loader that will load templates from the classpath.

Will load templates from from multiple instances of and arbitrary combinations of : This is a configuration-free loader, in that there are no parameters to be specified in the configuration properties, other than specifying this as the loader to use. For example the following is all that the loader needs to be functional :

resource.loader = class class.resource.loader.class = org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader

To use, put your template directories, jars and zip files into the classpath or other mechanisms that make resources accessable to the classloader.

This makes deployment trivial for web applications running in any Servlet 2.2 compliant servlet runner, such as Tomcat 3.2 and others.

For a Servlet Spec v2.2 servlet runner, just drop the jars of template files into the WEB-INF/lib directory of your webapp, and you won't have to worry about setting template paths or altering them with the root of the webapp before initializing.

I have also tried it with a WAR deployment, and that seemed to work just fine.

Version: $Id: ClasspathResourceLoader.java,v 1.8.4.1 2004/03/03 23:23:02 geirm Exp $

Author: Geir Magnusson Jr.

Method Summary
longgetLastModified(Resource resource)
Defaults to return 0
InputStreamgetResourceStream(String name)
Get an InputStream so that the Runtime can build a template with it.
voidinit(ExtendedProperties configuration)
This is abstract in the base class, so we need it
booleanisSourceModified(Resource resource)
Defaults to return false.

Method Detail

getLastModified

public long getLastModified(Resource resource)
Defaults to return 0

getResourceStream

public InputStream getResourceStream(String name)
Get an InputStream so that the Runtime can build a template with it.

Parameters: name name of template to get

Returns: InputStream containing the template

Throws: ResourceNotFoundException if template not found in classpath.

init

public void init(ExtendedProperties configuration)
This is abstract in the base class, so we need it

isSourceModified

public boolean isSourceModified(Resource resource)
Defaults to return false.
Copyright B) 2002 Apache Software Foundation. All Rights Reserved.