Class ProxyHandler

java.lang.Object

sunlabs.brazil.proxy.ProxyHandler

All Implemented Interfaces:

Handler

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.

Properties:

useproxy

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.

auth

The value of the proxy-authenticate header (if any) sent to the upstream proxy

proxyHost

If specified, the name of the upstream proxy

proxyPort

The up stream proxys port, if a proxyHost is specified (defaults to 80)

proxylog

If set all http headers will be logged to the console. This is for debugging.

Version:

2.6

Author:

Stephen Uhler

Field Summary

Fields

Modifier and Type	Field	Description
String	auth	The string to send as the value for the "Proxy-Authorization" HTTP header (if needed).
static final String	AUTH
static final String	PROXY_HOST
static final String	PROXY_PORT
String	proxyHost	The proxy server.
int	proxyPort	The proxy server's port.
static final String	USE_PROXY

Constructor Summary

Constructors

Constructor	Description
ProxyHandler()

Method Summary

Modifier and Type	Method	Description
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.
protected MimeHeaders	rewriteHeaders(MimeHeaders responseHeaders)	Allow sub-classes to rewrite any or all of the target headers, if needed.

Methods inherited from class Object

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

Field Details

PROXY_HOST

public static final String PROXY_HOST

See Also:

• Constant Field Values

PROXY_PORT

public static final String PROXY_PORT

See Also:

• Constant Field Values

AUTH

public static final String AUTH

See Also:

• Constant Field Values

USE_PROXY

public static final String USE_PROXY

See Also:

• Constant Field Values

proxyHost

public String proxyHost

The proxy server.

proxyPort

public int proxyPort

The proxy server's port. Default is 80.

auth

public String auth

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

Constructor Details

ProxyHandler

public ProxyHandler()

Method Details

init

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

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 client)
                throws IOException

Description copied from interface: Handler

Responds to an HTTP request.

Specified by:

respond in interface Handler

Parameters:

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

See Also:

• Handler.respond(Request)

rewriteHeaders

protected MimeHeaders rewriteHeaders(MimeHeaders responseHeaders)

Allow sub-classes to rewrite any or all of the target headers, if needed.

dumpHeaders

public static String dumpHeaders(int count,
 Request request,
 MimeHeaders headers,
 boolean sent)

Dump the headers on stderr