The TemplateHandler reads a template file from
the document root, based on the URL, and passes the content through
one or more template filters.
The following configuration parameters are used to initialize this
Handler:
prefix
Only URLs beginning with this string will be candidates for
template processing. The default is "/".
suffix
Suffix string for our requests.
templates
A list of Template class names.
Methods in the template classes will
be invoked to process the XML (or HTML) tags present in the content.
session
The name of the request property that the Session ID will be found
in, used to identify the proper template instance.
The default value is "SessionID". Typically, a sessionHandler,
such as CookieSessionHandler is used
upstream to create the sessionID. If no id is found, then the
session named "common" is used instead.
default
The default file in the directory to use as a template if
a directory name is specified. Defaults to index[suffix],
or "index.html" if no suffix is provided.
The request properties DirectoryName and
FileName may be set as a convinience for downstream handlers.
To filter content other than from the file system, use the
template filter instead.
server - The HTTP server that created this Handler.
Typical Handlers will use Server.props
to obtain run-time configuration information.
prefix - A prefix that this Handler may prepend to all
of the keys that it uses to extract configuration information
from Server.props. This is set (by the Server
and ChainHandler) to help avoid configuration parameter
namespace collisions.
For example, if a Handler uses the property
"account", and the specified prefix is "bank.", then the
Handler should actually examine the property
"bank.account" in Server.props.
Returns:
true if this Handler initialized
successfully, false otherwise. If
false is returned, this Handler
should not be used.
request - The Request object that represents the HTTP
request.
Returns:
true if the request was handled. A request was
handled if a response was supplied to the client, typically
by calling Request.sendResponse() or
Request.sendError.
Throws:
IOException - if there was an I/O error while sending the response to
the client. Typically, in that case, the Server
will (try to) send an error message to the client and then
close the client's connection.
The IOException should not be used to silently
ignore problems such as being unable to access some
server-side resource (for example getting a
FileNotFoundException due to not being able
to open a file). In that case, the Handler's
duty is to turn that IOException into a
HTTP response indicating, in this case, that a file could
not be found.
