Class AclSwitchHandler
java.lang.Object
sunlabs.brazil.handler.AclSwitchHandler
- All Implemented Interfaces:
Handler
Simple access control hander based on url prefixes or regexps.
Looks up list of valid prefixes or regular expressions in
Request.props
, and allows/denies
access based on those prefixes.
This is expected to work in conjunction with an upstream handler,
such as
RolesHandler
or
BasicAuthHandler
that examines the request, and place credentials into the
request object. The credentials consist of url prefixes
or regular expressions that match classes of url's. Documents
whose URL prefix don't match a credential are rejected.
If a credential does not begin with a slash (/), the init(Server, String)
prefix
for this handler is prepended.
Properties:
- prefix, suffix, glob, match
- Sepcify the URL that triggers this handler.
(See
MatchString
). - authName
- The name of the request.props entry to find a white-space delimited list of url prefixes or regular expression patterns. (defaults to "roles"). If the items in the list don't start with "/", then the url prefix is prepended (only for prefix matching).
- redirect
- Name of the url to re-direct to if permission is denied. If not specified, a simple message is sent to the client.
- useRegexp
- If provided, the list of credentials is interpreted as regular expressions, otherwise url prefixes are used.
- Version:
- 2.2, 06/11/13
- Author:
- Stephen Uhler
-
Constructor Summary
Constructors -
Method Summary
-
Constructor Details
-
AclSwitchHandler
public AclSwitchHandler()
-
-
Method Details
-
init
Description copied from interface:Handler
Initializes the handler.- 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
Description copied from interface:Handler
Responds to an HTTP request.- 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:
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.
-