Class ProxyHandler

  extended by sunlabs.brazil.proxy.ProxyHandler (view source)
All Implemented Interfaces:

public class ProxyHandler
extends Object
implements Handler

Handler for implementing a web proxy. By default, this is a dumb proxy. It can be combined with other handlers to generate side effects, such as content rewriting.


The name of the SocketFactory class to use for this handler. If additional properties are required to set up the SocketFactory, it should be configured as a handler instead. This is here for convenience only.
The value of the proxy-authenticate header (if any) sent to the upstream proxy
If specified, the name of the upstream proxy
The up stream proxys port, if a proxyHost is specified (defaults to 80)
If set all http headers will be logged to the console. This
If true, then transparent mode is enabled: The client can make a non-proxy http request, and the http "host" header is used to derive the proxy host. ma is for debugging.
This property is set to the fully qualified URL that was used to retrieve the URL, for the benefit of any downstream handlers.

Field Summary
 String auth
          The string to send as the value for the "Proxy-Authorization" HTTP header (if needed).
static String AUTH
static String PROXY_HOST
static String PROXY_PORT
 String proxyHost
          The proxy server.
 int proxyPort
          The proxy server's port.
static String USE_PROXY
Constructor Summary
Method Summary
static String dumpHeaders(int count, Request request, MimeHeaders headers, boolean sent)
          Dump the headers on stderr
 boolean init(Server server, String prefix)
          Do one-time setup.
 boolean respond(Request client)
          Responds to an HTTP request.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail


public static final String PROXY_HOST
See Also:
Constant Field Values


public static final String PROXY_PORT
See Also:
Constant Field Values


public static final String AUTH
See Also:
Constant Field Values


public static final String USE_PROXY
See Also:
Constant Field Values


public String proxyHost
The proxy server.


public int proxyPort
The proxy server's port. Default is 80.


public String auth
The string to send as the value for the "Proxy-Authorization" HTTP header (if needed).

Constructor Detail


public ProxyHandler()
Method Detail


public boolean init(Server server,
                    String prefix)
Do one-time setup. get and process the properties file options, and make sure

Specified by:
init in interface Handler
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.
true if this Handler initialized successfully, false otherwise. If false is returned, this Handler should not be used.


public boolean respond(Request client)
                throws IOException
Description copied from interface: Handler
Responds to an HTTP request.

Specified by:
respond in interface Handler
client - The Request object that represents the HTTP request.
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.
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.

See Also:


public static String dumpHeaders(int count,
                                 Request request,
                                 MimeHeaders headers,
                                 boolean sent)
Dump the headers on stderr

Version Kenai-svn-r24, Generated 08/18/09
Copyright (c) 2001-2009, Sun Microsystems.