Class RolesHandler

java.lang.Object
sunlabs.brazil.handler.RolesHandler
All Implemented Interfaces:
Handler
public class RolesHandler extends Object implements Handler
Handler for associating roles with an id. This is a placeholder until the SunEconomy gets integrated in. It looks for an "id" in the request, looks it up in a property file, then adds the value of the id into the request. It may be used in conjunction with AclSwitchHandler to provide role based web access. Properties:
prefix, suffix, glob, match
Specify the URL that triggers this handler. (See MatchString).
SessionID
The property to use to look up the id. Defaults to "SessionID".
roleName
The property to place the result of the id lookup into. Defaults to "roleName";
mapFile
The absolute path to the java properties file containing the it to role mapping.
Version:
@(#) RolesHandler.java 2.3 06/11/13 15:04:24
Author:
Stephen Uhler

  • Field Details

    • ID_KEY

      public static final String ID_KEY
      Handler configuration property SessionID. The request property name to find the id string. Defaults to id.
      See Also:

    • ROLE_KEY

      public static final String ROLE_KEY
      Handler configuration property roleName. The request property name to place the roles into. Defaults to roles.
      See Also:

    • MAP

      public static final String MAP
      Handler configuration property mapFile. The path to the java properties file containing the id to roles mapping. The roles are a whitespace delimited list of ascii role names.
      See Also:

  • Constructor Details

    • RolesHandler

      public RolesHandler()

  • Method Details

    • init

      public boolean init(Server server, String prefix)
      Description copied from interface: Handler
      Initializes the 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
      Dispatch and handle the request. This version looks at the request for the id, looks it up in the table, and adds the value, if available
      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.