Package sunlabs.brazil.handler
Class NotFoundHandler
- java.lang.Object
-
- sunlabs.brazil.handler.NotFoundHandler
-
- All Implemented Interfaces:
Handler
public class NotFoundHandler extends java.lang.Object implements Handler
Handler for returning "file not found" errors back to the client. Look for the file "NotFound.html" in the current directory, and return it if it exists. Otherwise, return the "NotFound.html" file in the document root directory. If neither can be found, then punt, and let someone else deal with it.If more sophisticated processing is desired, then the
UrlMapperHandler
may be used in combination with theTemplateHandler
.Configuration parameters understood by this handler
- root
- The location of the document root for locating the default "not found" file (also looks using prefix of "").
- prefix, suffix, glob, match
- Specify the URL that triggers this handler.
(See
MatchString
). - fileName
- The name of the file to send for missing files. Defaults to "notfound.html"
- type
- The file type, defaults to text/html
- Version:
- 2.3, 06/11/13
- Author:
- Stephen Uhler
-
-
Constructor Summary
Constructors Constructor Description NotFoundHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
init(Server server, java.lang.String prefix)
Extract the handler properties.boolean
respond(Request request)
Look for and deliver the "not found" file Look in the current directory first, then in the doc root.
-
-
-
Method Detail
-
init
public boolean init(Server server, java.lang.String prefix)
Extract the handler properties. Get the URL prefix and default "missing" file name.- 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
Look for and deliver the "not found" file Look in the current directory first, then in the doc root. Only files whose suffixes have valid mime types are delivered.- Specified by:
respond
in interfaceHandler
- Parameters:
request
- TheRequest
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 callingRequest.sendResponse()
orRequest.sendError
.- 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.
-
-