sunlabs.brazil.handler
Class DefaultFileHandler

java.lang.Object
  sunlabs.brazil.handler.DefaultFileHandler (view source)

All Implemented Interfaces:

Handler

public class DefaultFileHandler
extends Object
implements Handler

Handler for appending a url ending with '/' into the appropriate url based on a default file in the file system.

The following request properties are used:

defaults

The names of the default files to search for in the directory implied by the URL. The first one that exists will cause its name to be appended to the URL. Defaults to "index.html".

root

The document root to look for files. If none is found with our prefix, then "root" is examined. Defaults to ".".

DirectoryName

This property is set if the URL represents a valid directory in the document root.

fileName

This property is set to the name of the default file, if one was found.

If a url ends with "/", but is a readable plain file, the "/" is removed

Constructor Summary

DefaultFileHandler()

Method Summary

boolean	init(Server server, String prefix) Remember our prefix in the properties table.
boolean	respond(Request request) If the url ends with a "/" look around in the corrosponding directory to find a suitable default file, and then change the url.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFileHandler

public DefaultFileHandler()

Method Detail

init

public boolean init(Server server,
                    String prefix)

Remember our prefix in the properties table.

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

If the url ends with a "/" look around in the corrosponding directory to find a suitable default file, and then change the url.

Specified by:

respond in interface Handler

Parameters:

request - The Request object that represents the HTTP request.

Returns:

Always returns false.

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.