public class FileTemplateLoader extends Object implements TemplateLoader
TemplateLoader that uses files in a specified directory as the
source of templates. If contains security checks that will prevent it
serving templates outside the template directory (like <include /etc/passwd>.
It compares canonical paths for this, so templates that are symbolically
linked into the template directory from outside of it won't work either.| Constructor and Description |
|---|
FileTemplateLoader()
Creates a new file template cache that will use the current directory
(the value of the system property
user.dir as the base
directory for loading templates. |
FileTemplateLoader(File baseDir)
Creates a new file template loader that will use the specified directory
as the base directory for loading templates.
|
FileTemplateLoader(File baseDir,
boolean allowLinking)
Creates a new file template loader that will use the specified directory
as the base directory for loading templates.
|
| Modifier and Type | Method and Description |
|---|---|
void |
closeTemplateSource(Object templateSource)
Closes the template source.
|
Object |
findTemplateSource(String name)
Finds the object that acts as the source of the template with the
given name.
|
File |
getBaseDirectory()
Returns the base directory in which the templates are searched.
|
long |
getLastModified(Object templateSource)
Returns the time of last modification of the specified template source.
|
Reader |
getReader(Object templateSource,
String encoding)
Returns the character stream of a template represented by the specified
template source.
|
String |
toString()
Show class name and some details that are useful in template-not-found errors.
|
public final File baseDir
public FileTemplateLoader()
throws IOException
user.dir as the base
directory for loading templates. It will not allow access to template
files that are accessible through symlinks that point outside the
base directory.IOExceptionpublic FileTemplateLoader(File baseDir) throws IOException
baseDir - the base directory for loading templatesIOExceptionpublic FileTemplateLoader(File baseDir, boolean allowLinking) throws IOException
baseDir - the base directory for loading templatesallowLinking - if true, it will allowIOExceptionpublic Object findTemplateSource(String name) throws IOException
TemplateLoaderTemplateCache when a template
is requested, before calling either TemplateLoader.getLastModified(Object) or
TemplateLoader.getReader(Object, String).findTemplateSource in interface TemplateLoadername - 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.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!IOExceptionpublic long getLastModified(Object templateSource)
TemplateLoaderfindTemplateSource().getLastModified in interface TemplateLoadertemplateSource - an object representing a template source, obtained
through a prior call to TemplateLoader.findTemplateSource(String).public Reader getReader(Object templateSource, String encoding) throws IOException
TemplateLoaderReader that
reads the template from its beginning. Before this method is called for the
second time (or later), its caller must close the previously returned
Reader, and it must not use it anymore. That is, this method is not
required to support multiple concurrent readers for the same source
templateSource object.
Typically, this method is called if the template is missing from the cache,
or if after calling TemplateLoader.findTemplateSource(String) and TemplateLoader.getLastModified(Object)
it was determined that the cached copy of the template is stale. Then, if it turns out that the
encoding parameter passed doesn't match the actual template content, this method will be called for a
second time with the correct encoding parameter value.
getReader in interface TemplateLoadertemplateSource - 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 should ignore the encoding parameter.TemplateCache usually) to
close() it.IOException - if an I/O error occurs while accessing the stream.public void closeTemplateSource(Object templateSource)
TemplateLoaderTemplateCache for a template source. TemplateCache ensures that
this method will be called on every object that is returned from
TemplateLoader.findTemplateSource(String).closeTemplateSource in interface TemplateLoadertemplateSource - the template source that should be closed.public File getBaseDirectory()