Package sunlabs.brazil.handler
Class RolesHandler
- java.lang.Object
-
- sunlabs.brazil.handler.RolesHandler
-
- All Implemented Interfaces:
Handler
public class RolesHandler extends java.lang.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 withAclSwitchHandler
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:
- Author:
- Stephen Uhler
-
-
Constructor Summary
Constructors Constructor Description RolesHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
init(Server server, java.lang.String prefix)
Initializes the handler.boolean
respond(Request request)
Dispatch and handle the request.
-
-
-
Field Detail
-
ID_KEY
public static final java.lang.String ID_KEY
Handler configuration property SessionID. The request property name to find the id string. Defaults to id.- See Also:
- Constant Field Values
-
ROLE_KEY
public static final java.lang.String ROLE_KEY
Handler configuration property roleName. The request property name to place the roles into. Defaults to roles.- See Also:
- Constant Field Values
-
MAP
public static final java.lang.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:
- Constant Field Values
-
-
Method Detail
-
init
public boolean init(Server server, java.lang.String prefix)
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
public boolean respond(Request request) throws java.io.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 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:
java.io.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.
-
-