|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectResourceLoader
org.apache.velocity.tools.view.WebappResourceLoader
public class WebappResourceLoader
Resource loader that uses the ServletContext of a webapp to load Velocity templates. (it's much easier to use with servlets than the standard FileResourceLoader, in particular the use of war files is transparent). The default search path is '/' (relative to the webapp root), but you can change this behaviour by specifying one or more paths by mean of as many webapp.resource.loader.path properties as needed in the velocity.properties file. All paths must be relative to the root of the webapp. To enable caching and cache refreshing the webapp.resource.loader.cache and webapp.resource.loader.modificationCheckInterval properties need to be set in the velocity.properties file ... auto-reloading of global macros requires the webapp.resource.loader.cache property to be set to 'false'.
Field Summary | |
---|---|
protected java.lang.String[] |
paths
The root paths for templates (relative to webapp's root). |
protected ServletContext |
servletContext
|
protected java.util.HashMap |
templatePaths
|
Constructor Summary | |
---|---|
WebappResourceLoader()
|
Method Summary | |
---|---|
private java.io.File |
getCachedFile(java.lang.String rootPath,
java.lang.String fileName)
|
long |
getLastModified(Resource resource)
Checks to see when a resource was last modified |
java.io.InputStream |
getResourceStream(java.lang.String name)
Get an InputStream so that the Runtime can build a template with it. |
void |
init(ExtendedProperties configuration)
This is abstract in the base class, so we need it. |
boolean |
isSourceModified(Resource resource)
Checks to see if a resource has been deleted, moved or modified. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected java.lang.String[] paths
protected java.util.HashMap templatePaths
protected ServletContext servletContext
Constructor Detail |
---|
public WebappResourceLoader()
Method Detail |
---|
public void init(ExtendedProperties configuration)
configuration
- the ExtendedProperties
associated with
this resource loader.public java.io.InputStream getResourceStream(java.lang.String name) throws ResourceNotFoundException
name
- name of template to get
ResourceNotFoundException
- if template not found
in classpath.private java.io.File getCachedFile(java.lang.String rootPath, java.lang.String fileName)
public boolean isSourceModified(Resource resource)
resource
- Resource The resource to check for modification
public long getLastModified(Resource resource)
resource
- Resource the resource to check
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |