freemarker.cache

Class WebappTemplateLoader

java.lang.Object

freemarker.cache.WebappTemplateLoader

All Implemented Interfaces:

TemplateLoader

public class WebappTemplateLoader
extends java.lang.Object
implements TemplateLoader

A TemplateLoader that uses streams reachable through ServletContext.getResource(String) as its source of templates.

Author:

Attila Szegedi

Constructor Summary

Constructors

Constructor and Description
WebappTemplateLoader(javax.servlet.ServletContext servletContext) Creates a resource template cache that will use the specified servlet context to load the resources.
WebappTemplateLoader(javax.servlet.ServletContext servletContext, java.lang.String path) Creates a template loader that will use the specified servlet context to load the resources.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeTemplateSource(java.lang.Object templateSource) Closes the template source.
java.lang.Object	findTemplateSource(java.lang.String name) Finds the object that acts as the source of the template with the given name.
long	getLastModified(java.lang.Object templateSource) Returns the time of last modification of the specified template source.
java.io.Reader	getReader(java.lang.Object templateSource, java.lang.String encoding) Returns the character stream of a template represented by the specified template source.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebappTemplateLoader

public WebappTemplateLoader(javax.servlet.ServletContext servletContext)

Creates a resource template cache that will use the specified servlet context to load the resources. It will use the base path of "/" meaning templates will be resolved relative to the servlet context root location.

Parameters:

servletContext - the servlet context whose ServletContext.getResource(String) will be used to load the templates.

WebappTemplateLoader

public WebappTemplateLoader(javax.servlet.ServletContext servletContext,
                    java.lang.String path)

Creates a template loader that will use the specified servlet context to load the resources. It will use the specified base path. The is interpreted as relative to the current context root (does not mater if you start it with "/" or not). Path components should be separated by forward slashes independently of the separator character used by the underlying operating system.

Parameters:

servletContext - the servlet context whose ServletContext.getResource(String) will be used to load the templates.

path - the base path to template resources.

Method Detail

findTemplateSource

public java.lang.Object findTemplateSource(java.lang.String name)
                                    throws java.io.IOException

Description copied from interface: TemplateLoader

Finds the object that acts as the source of the template with the given name. This method is called by the TemplateCache when a template is requested, before calling either TemplateLoader.getLastModified(Object) or TemplateLoader.getReader(Object, String).

Specified by:

findTemplateSource in interface TemplateLoader

Parameters:

name - the name of the template, already localized and normalized by the cache. It is completely up to the loader implementation to interpret the name, however it should expect to receive hierarchical paths where path components are separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are not considered as separators by FreeMarker, and thus they will not be replaced with slash before passing to this method, so it's up to the template loader to handle them (say, be throwing and exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash -- typical mistake of Windows users). The passed names are always considered relative to some loader-defined root location (often referred as the "template root directory"), and will never start with a slash, nor will they contain a path component consisting of either a single or a double dot -- these are all resolved by the template cache before passing the name to the loader. As a side effect, paths that trivially reach outside template root directory, such as ../my.ftl, will be rejected by the template cache, so they never reach the template loader. Note again, that if the path uses backslash as path separator instead of slash as (the template loader should not accept that), the normalization will not properly happen, as FreeMarker (the cache) recognizes only the slashes as separators.

Returns:

an object representing the template source, which can be supplied in subsequent calls to TemplateLoader.getLastModified(Object) and TemplateLoader.getReader(Object, String). Null must be returned if the source for the template can not be found (do not throw FileNotFoundException!). The returned object may will be compared with a cached template source object for equality, using the equals method. Thus, objects returned for the same physical source must be equivalent according to equals method, otherwise template caching can become very ineffective!

Throws:

java.io.IOException

getLastModified

public long getLastModified(java.lang.Object templateSource)

Description copied from interface: TemplateLoader

Returns the time of last modification of the specified template source. This method is called after findTemplateSource().

Specified by:

getLastModified in interface TemplateLoader

Parameters:

templateSource - an object representing a template source, obtained through a prior call to TemplateLoader.findTemplateSource(String).

Returns:

the time of last modification of the specified template source, or -1 if the time is not known.

getReader

public java.io.Reader getReader(java.lang.Object templateSource,
                       java.lang.String encoding)
                         throws java.io.IOException

Description copied from interface: TemplateLoader

Returns the character stream of a template represented by the specified template source. This method is called after getLastModified() if it's determined that a cached copy of the template is unavailable or stale.

Specified by:

getReader in interface TemplateLoader

Parameters:

templateSource - an object representing a template source, obtained through a prior call to TemplateLoader.findTemplateSource(String).

encoding - the character encoding used to translate source bytes to characters. Some loaders may not have access to the byte representation of the template stream, and instead directly obtain a character stream. These loaders will should ignore the encoding parameter.

Returns:

a reader representing the template character stream. The framework will call close().

Throws:

java.io.IOException - if an I/O error occurs while accessing the stream.

closeTemplateSource

public void closeTemplateSource(java.lang.Object templateSource)
                         throws java.io.IOException

Description copied from interface: TemplateLoader

Closes the template source. This is the last method that is called by the TemplateCache for a template source. The framework guarantees that this method will be called on every object that is returned from TemplateLoader.findTemplateSource(String).

Specified by:

closeTemplateSource in interface TemplateLoader

Parameters:

templateSource - the template source that should be closed.

Throws:

java.io.IOException