Package sunlabs.brazil.handler
Class DefaultFileHandler
- java.lang.Object
-
- sunlabs.brazil.handler.DefaultFileHandler
-
- All Implemented Interfaces:
Handler
public class DefaultFileHandler extends java.lang.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.
- Version:
- %V% 05/06/28
- Author:
- Stephen Uhler
-
-
Constructor Summary
Constructors Constructor Description DefaultFileHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
init(Server server, java.lang.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.
-
-
-
Method Detail
-
init
public boolean init(Server server, java.lang.String prefix)
Remember our prefix in the properties table.- Specified by:
init
in interfaceHandler
- Parameters:
server
- The HTTP server that created thisHandler
. TypicalHandler
s will useServer.props
to obtain run-time configuration information.prefix
- The handlers name. The string thisHandler
may prepend to all of the keys that it uses to extract configuration information fromServer.props
. This is set (by theServer
andChainHandler
) to help avoid configuration parameter namespace collisions.- Returns:
true
if thisHandler
initialized successfully,false
otherwise. Iffalse
is returned, thisHandler
should not be used.
-
respond
public boolean respond(Request request) throws java.io.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 interfaceHandler
- Parameters:
request
- TheRequest
object that represents the HTTP request.- Returns:
- Always returns false.
- Throws:
java.io.IOException
- if there was an I/O error while sending the response to the client. Typically, in that case, theServer
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 aFileNotFoundException
due to not being able to open a file). In that case, theHandler
's duty is to turn thatIOException
into a HTTP response indicating, in this case, that a file could not be found.
-
-