Package sunlabs.brazil.handler
Class PropertiesHandler
- java.lang.Object
-
- sunlabs.brazil.handler.PropertiesHandler
-
- All Implemented Interfaces:
Handler
public class PropertiesHandler extends java.lang.Object implements Handler
Handler for returning selected request properties as a text/plain document in java properties format. A server using this handler may be called by a server using theProxyPropertiesHandler
to communicate per-request properties between the two servers.Properties:
- prefix, suffix, glob, match
- Specify the URL that triggers this handler.
(See
MatchString
). - select
- Glob pattern to match properties selected (Defaults to *). This is re-examined at every request.
- type
- Type of output to generate (defaults to text/plain).
- comment
- Comment to put on output (defaults to select).
- Version:
- Author:
- Stephen Uhler
-
-
Constructor Summary
Constructors Constructor Description PropertiesHandler()
-
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)
If this is one of our URL's, look through each request property, and selct those that match the Select property.
-
-
-
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
If this is one of our URL's, look through each request property, and selct those that match the Select property. Then emit them all as text/plain.- 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.
-
-