Package sunlabs.brazil.handler

Class HomeDirHandler

  • All Implemented Interfaces:
    Handler
    public class HomeDirHandler
extends java.lang.Object
implements Handler
    Handler for converting ~username queries. When invoked upstream of the FileHandler This provides Unix user's with individual home pages.

    Properties:

    subdir
    Name of the directory in the user's home directory that represents the user's "doc root"
    home
    The mount-point for home directories, defaults to "/home/".
    root
    The name of the root property to set. Defaults to "root".
    prefix
    The url prefix used to identify home directory queries. Defaults to "/~".
    Url's of the form: 
    /~[user]/stuff...
    are transformed into [home][user]/[subdir]/stuff....

    Note: This functionallity has been mostly subsumed by the UrlMapperHandler.

    Version:
    2.2, 04/11/03
    Author:
    Stephen Uhler

    • Constructor Summary

      Constructors 
      Constructor Description
      HomeDirHandler()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean init​(Server server, java.lang.String prefix)
      Get and set the configuration parameters.
      boolean respond​(Request request)
      If this is a ~user request, modify the root and url properties of the request object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HomeDirHandler

        public HomeDirHandler()

    • Method Detail

      • init

        public boolean init​(Server server,
                    java.lang.String prefix)
        Get and set the configuration parameters.
        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 java.io.IOException
        If this is a ~user request, modify the root and url properties of the request object.
        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:
        java.io.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.