sunlabs.brazil.handler
Class PropertiesHandler

java.lang.Object
  sunlabs.brazil.handler.PropertiesHandler (view source)

All Implemented Interfaces:

Handler

public class PropertiesHandler
extends 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 the ProxyPropertiesHandler 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).

Constructor Summary

PropertiesHandler()

Method Summary

boolean	init(Server server, 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropertiesHandler

public PropertiesHandler()

Method Detail

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

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 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.