sunlabs.brazil.handler
Class DirectoryHandler

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

All Implemented Interfaces:

Handler

public class DirectoryHandler
extends Object
implements Handler

This is a bare-bones handler for providing directory listings for web servers. It is designed to be placed after the FileHandler. If no index file is found, Then a simple directory listing will be produced. Only files whose extensions are in the mime properties will be listed.

NOTE: This handler is obsolete, as it provides no control over the format of the directory listing, Use the DirectoryTemplate instead.

Configuration properties used:

prefix, suffix, glob, match

Specify the URL that triggers this handler. (See MatchString).

DirectoryName

This property is set by the FileHandler if the URL it was passed resolves to a directory, but no index file (e.g. index.html) was found.

setProps

If present, no content is returned. Instead, The properties "Directories" and "Files" are set in the request properties, so the format of the output may be generated dynamically. [Note: This feature is deprecated, use the DirectoryTemplate instead].

delim

The delimeter separating the file names. Defaults to a single space.

mime.xxx

Only documents ending in ".xxx" are considered. more than on mime.xxx parameters may be specified.

Constructor Summary

DirectoryHandler()

Method Summary

boolean	init(Server server, String prefix) Get the url prefix for this handler.
boolean	respond(Request request) Display files in a directory, after being rejected by the FileHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryHandler

public DirectoryHandler()

Method Detail

init

public boolean init(Server server,
                    String prefix)

Get the url prefix for this 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

Display files in a directory, after being rejected by the FileHandler. The output is very simple.

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.