sunlabs.brazil.sunlabs
Class InitTemplatesHandler

java.lang.Object
  extended by sunlabs.brazil.sunlabs.InitTemplatesHandler (view source)
All Implemented Interfaces:
Handler

public class InitTemplatesHandler
extends Object
implements Handler

Process a template file during server startup. This handler processes no requests, It creates a "dummy" request, and processes it through a template (or templates) at server startup time for the template's side effects.

templates
The list of templates (or template tokens) to use for processing the template (required).
file
The file to use for the template for initial processing, relative to the document root. Defaults to "init.template".
session
The name of the session for the template to use. Defaults to "common".
prefix
The name of the templateHandler or templateFilter configuration prefix to share namespaces with. If this is not set properly, the only shared namespace will be "server". For example, the following server configuration fragment:
 handlers=init ... template
 init.class=sunlabs.brazil.sunlabs.InitTemplatesHandler
 init.session=init
 init.prefix=template
 init.templates=set bsl ...

 template.class=sunlabs.brazil.template.TemplateHandler
 template.templates=set bsl ...

 set.class=sunlabs.brazil.template.SetTemplate
 
would allow "init.template" to contain:
 <set name=testing namespace=squirrel value=something>
 
and allow the TemplateHandler templates to see the variable "testing" with markup like:
 <import namespace=squirrel>
 <get name=testing>
 

As there is no client request associated with this template, many of the request properties normally associated with a client request will not be available. This Handler sets the following request properties:

SessionID
Is set the the session name
Initializing
Is set to "true".


Constructor Summary
InitTemplatesHandler()
           
 
Method Summary
 boolean init(Server server, String prefix)
          Initializes the handler.
 boolean respond(Request request)
          Responds to an HTTP request.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InitTemplatesHandler

public InitTemplatesHandler()
Method Detail

init

public boolean init(Server server,
                    String prefix)
Description copied from interface: Handler
Initializes the handler.

Specified by:
init in interface Handler
Parameters:
server - 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.
Returns:
true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.

respond

public boolean respond(Request request)
                throws IOException
Description copied from interface: Handler
Responds to an HTTP request.

Specified by:
respond in interface Handler
Parameters:
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.


Version Kenai-svn-r24, Generated 08/18/09
Copyright (c) 2001-2009, Sun Microsystems.