|
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--sunlabs.brazil.filter.TemplateFilter
The TemplateFilter sends HTML content through an
Html/XML parser to a set of Templates. Each Html/XML tag may
dynamically invoke a Java method present in the Templates.
The dynamically-generated content from evaluating the Html/XML tags is
returned to the caller.
The following configuration parameters are used to initialize this
Filter.
templates
name.class is examined to determine which class to
use for each template. Then name is used as the prefix
for other template specific properties if any. If
name.class does not exist, then name
is assumed to be the class name, and there are no template specific
properties for the template. Methods in the template classes will be
invoked to process the XML/HTML tags present in the content.
session
subtype
encoding
outputEncoding
tagPrefix
tagPrefix option is not specified for an individual template.
TemplateHandler class is similar, but not identical to
running a FilterHandler with the FileHandler and
the TemplateFilter. The differences between the two should
be resolved.
Note: The templates property accepts a list of
class names or tokens that could be used to represent
class names. If class names are used, all
template classes share the TemplateHandler's properties prefix.
| Constructor Summary | |
TemplateFilter()
|
|
| Method Summary | |
byte[] |
filter(Request request,
MimeHeaders headers,
byte[] content)
Evaluates the content as html/XML tags, if the file is (or has now been converted to) "text/html". |
boolean |
init(Server server,
String prefix)
Initializes the handler. |
boolean |
respond(Request request)
No action before request is made |
boolean |
shouldFilter(Request request,
MimeHeaders headers)
Filters all HTML files, or files that are likely to be html files, specifically, those whose "Content-Type" starts with "text/". |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public TemplateFilter()
| Method Detail |
public boolean init(Server server,
String prefix)
Handler
init in interface Handlerserver - The HTTP server that created this Handler.
Typical Handlers will use Server.props
to obtain run-time configuration information.prefix - The handlers name.
The string 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.
true if this Handler initialized
successfully, false otherwise. If
false is returned, this Handler
should not be used.public boolean respond(Request request)
respond in interface Handlerrequest - The Request object that represents the HTTP
request.
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.
public boolean shouldFilter(Request request,
MimeHeaders headers)
shouldFilter in interface Filterrequest - The in-progress HTTP request.headers - The MIME headers generated by the wrapped Handler.
true if this filter would like to examine and
possibly rewrite the content, false otherwise.
public byte[] filter(Request request,
MimeHeaders headers,
byte[] content)
filter in interface Filterrequest - The finished HTTP request.headers - The MIME headers generated by the Handler.content - The output from the Handler that this
Filter may rewrite.
Filter may return
the original content unchanged. The
Filter may return null to indicate
that the FilterHandler should stop processing the
request and should not return any content to the client.
|
Version 2.1, Generated 12/30/04 Copyright (c) 2001-2004, Sun Microsystems. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||