WebappResourceLoader (VelocityTools 2.0 Documentation)

java.lang.Object
- ResourceLoader
- - org.apache.velocity.tools.view.WebappResourceLoader

Direct Known Subclasses:

WebappLoader
```
public class WebappResourceLoader
extends ResourceLoader
```
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'.

Version:

$Id: WebappResourceLoader.java 712011 2008-11-06 23:35:43Z nbubna $

Author:

Geir Magnusson Jr., Nathan Bubna, Claude Brisson

Field Summary

Fields
Modifier and Type	Field and Description
`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

Constructors
Constructor and Description

WebappResourceLoader()

Constructors
Constructor and Description
`WebappResourceLoader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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
  - paths
```
protected java.lang.String[] paths
```
    The root paths for templates (relative to webapp's root).
  - templatePaths
```
protected java.util.HashMap templatePaths
```
  - servletContext
```
protected ServletContext servletContext
```
- Constructor Detail
  - WebappResourceLoader
```
public WebappResourceLoader()
```
- Method Detail
  - init
```
public void init(ExtendedProperties configuration)
```
    This is abstract in the base class, so we need it.
    NOTE: this expects that the ServletContext has already been placed in the runtime's application attributes under its full class name (i.e. "javax.servlet.ServletContext").
    
    Parameters:
    
    configuration - the ExtendedProperties associated with this resource loader.
  - getResourceStream
```
public java.io.InputStream getResourceStream(java.lang.String name)
                                      throws ResourceNotFoundException
```
    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.
  - getCachedFile
```
private java.io.File getCachedFile(java.lang.String rootPath,
                                   java.lang.String fileName)
```
  - isSourceModified
```
public boolean isSourceModified(Resource resource)
```
    Checks to see if a resource has been deleted, moved or modified.
    
    Parameters:
    
    resource - Resource The resource to check for modification
    
    Returns:
    
    boolean True if the resource has been modified
  - getLastModified
```
public long getLastModified(Resource resource)
```
    Checks to see when a resource was last modified
    
    Parameters:
    
    resource - Resource the resource to check
    
    Returns:
    
    long The time when the resource was last modified or 0 if the file can't be read

Class WebappResourceLoader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

paths

templatePaths

servletContext

Constructor Detail

WebappResourceLoader

Method Detail

init

getResourceStream

getCachedFile

isSourceModified

getLastModified