Package sunlabs.brazil.proxy
Class ProxyHandler
- java.lang.Object
-
- sunlabs.brazil.proxy.ProxyHandler
-
- All Implemented Interfaces:
Handler
public class ProxyHandler extends java.lang.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 java.lang.String
auth
The string to send as the value for the "Proxy-Authorization" HTTP header (if needed).static java.lang.String
AUTH
static java.lang.String
PROXY_HOST
static java.lang.String
PROXY_PORT
java.lang.String
proxyHost
The proxy server.int
proxyPort
The proxy server's port.static java.lang.String
USE_PROXY
-
Constructor Summary
Constructors Constructor Description ProxyHandler()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static java.lang.String
dumpHeaders(int count, Request request, MimeHeaders headers, boolean sent)
Dump the headers on stderrboolean
init(Server server, java.lang.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.
-
-
-
Field Detail
-
PROXY_HOST
public static final java.lang.String PROXY_HOST
- See Also:
- Constant Field Values
-
PROXY_PORT
public static final java.lang.String PROXY_PORT
- See Also:
- Constant Field Values
-
AUTH
public static final java.lang.String AUTH
- See Also:
- Constant Field Values
-
USE_PROXY
public static final java.lang.String USE_PROXY
- See Also:
- Constant Field Values
-
proxyHost
public java.lang.String proxyHost
The proxy server.
-
proxyPort
public int proxyPort
The proxy server's port. Default is 80.
-
auth
public java.lang.String auth
The string to send as the value for the "Proxy-Authorization" HTTP header (if needed).
-
-
Method Detail
-
init
public boolean init(Server server, java.lang.String prefix)
Do one-time setup. get and process the properties file options, and make sure- 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 client) throws java.io.IOException
Description copied from interface:Handler
Responds to an HTTP request.- Specified by:
respond
in interfaceHandler
- Parameters:
client
- 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.- See Also:
Handler.respond(sunlabs.brazil.server.Request)
-
rewriteHeaders
protected MimeHeaders rewriteHeaders(MimeHeaders responseHeaders)
Allow sub-classes to rewrite any or all of the target headers, if needed.
-
dumpHeaders
public static java.lang.String dumpHeaders(int count, Request request, MimeHeaders headers, boolean sent)
Dump the headers on stderr
-
-