| 
 |   | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object | +--sunlabs.brazil.template.TemplateHandler
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: 
text
	are processed. See FileHandler for a
	description of how to set mime types for url suffixes.
 (See MatchString).
 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
 CookieSessionHandler is used
	upstream to create the sessionID.  If no id is found, then the
	session named "common" is used instead.  Exactly one instance of
	each template class is created for each session.
 default
 encoding
 outputEncoding
 modified
 
	last-modified header is added to the response with the
	current time.
 debug
	if set to "true", template debugging is enabled: templates will emit
	their pre-processed markup as an HTML comment.  This parameter only takes effect
	if the debug option is not specified for an individual template.
 tagPrefix
 tagPrefix option is not specified for an individual template.
 The request properties DirectoryName and
    fileName may be set as a convenience for downstream handlers.
 
 This handler duplicates some of the functionality of the
 template filter, 
 so that it may be used by itself in simple configurations.  As such, 
 if issues re-directs if directories are given without a trailing "/", 
 and uses an "index" file (see default above) if a directory
 name is specified.
 
 To filter content other than from the file system, use the
 template filter instead.
| Constructor Summary | |
| TemplateHandler() | |
| Method Summary | |
|  String | getContent(Request request,
           File file,
           String encoding)get the content associated with this template. | 
|  boolean | init(Server server,
     String propsPrefix)Initializes the handler. | 
|  boolean | respond(Request request)Process an html template file, using the supplied template processing classes. | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public TemplateHandler()
| Method Detail | 
public boolean init(Server server,
                    String propsPrefix)
Handler
init in interface Handlerserver - The HTTP server that created this Handler.
		Typical Handlers will use Server.props
		to obtain run-time configuration information.propsPrefix - 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)
                throws IOException
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.
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.
public String getContent(Request request,
                         File file,
                         String encoding)
                  throws IOException
request - The standard request objectfile - The file object to get the template from
IOException| 
 | 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 | ||||||||