Class RestrictClientHandler

java.lang.Object
sunlabs.brazil.handler.RestrictClientHandler
All Implemented Interfaces:
Handler
public class RestrictClientHandler extends Object implements Handler
Simple access control hander based on source ip addresses. Compare the ip address of the client with a regular expression. Only allow access to the specified url prefix if there is a match.

Properties:

prefix, suffix, glob, match
Specify the URL that triggers this handler. (See MatchString).
allow
The regular expression that matches the ip addresses of clients (in xxx.xxx.xxx.xxx format) that are permitted to access url's starting with prefix.
deny
The regular expression that matches the set of ip names that should be denied access. This is to make complying with silly EAR requirements easier. The use of this option implies a reverse DNS lookup, which could be expensive, as DNS names (and not ip addresses) are used for the comparison. Case insensitive matching is used.
redirect
Name of the url to re-direct to if permission is denied. If not specified, a simple message is sent to the client.
Version:
2.2, 06/11/13
Author:
Stephen Uhler

  • Constructor Details

    • RestrictClientHandler

      public RestrictClientHandler()

  • 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
      Description copied from interface: Handler
      Responds to an HTTP request.
      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.