Class NotFoundHandler

java.lang.Object
sunlabs.brazil.handler.NotFoundHandler
All Implemented Interfaces:
Handler
public class NotFoundHandler extends 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 the TemplateHandler.

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 Details

    • NotFoundHandler

      public NotFoundHandler()

  • Method Details

    • init

      public boolean init(Server server, String prefix)
      Extract the handler properties. Get the URL prefix and default "missing" file name.
      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
      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 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.