org.littleshoot.proxy

Class DefaultHttpProxyServer

java.lang.Object

org.littleshoot.proxy.DefaultHttpProxyServer

All Implemented Interfaces:

HttpProxyServer

public class DefaultHttpProxyServer
extends Object
implements HttpProxyServer

HTTP proxy server.

Constructor Summary

Constructors

Constructor and Description
DefaultHttpProxyServer(int port) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpRequestFilter requestFilter) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpRequestFilter requestFilter, org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory, org.jboss.netty.util.Timer timer, org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory)
DefaultHttpProxyServer(int port, HttpRequestFilter requestFilter, HttpResponseFilters responseFilters) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpResponseFilters responseFilters) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpResponseFilters responseFilters, ChainProxyManager chainProxyManager, HandshakeHandlerFactory handshakeHandlerFactory, HttpRequestFilter requestFilter) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpResponseFilters responseFilters, ChainProxyManager chainProxyManager, HandshakeHandlerFactory handshakeHandlerFactory, HttpRequestFilter requestFilter, org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory, org.jboss.netty.util.Timer timer, org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpResponseFilters responseFilters, ChainProxyManager chainProxyManager, HandshakeHandlerFactory handshakeHandlerFactory, HttpRequestFilter requestFilter, org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory, org.jboss.netty.util.Timer timer, org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory, ProxyCacheManager cacheManager) Creates a new proxy server.
DefaultHttpProxyServer(int port, HttpResponseFilters responseFilters, ProxyCacheManager cacheManager) Creates a new proxy server.
DefaultHttpProxyServer(int port, ProxyCacheManager cacheManager) Creates a new proxy server.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProxyAuthenticationHandler(ProxyAuthorizationHandler pah) Adds a new handler for proxy authentication.
void	start() Starts the server.
void	start(boolean localOnly, boolean anyAddress) Starts the server.
void	stop() Stops the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpResponseFilters responseFilters)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

responseFilters - The Map of request domains to match with associated HttpFilters for filtering responses to those requests.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpResponseFilters responseFilters,
                      ProxyCacheManager cacheManager)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

responseFilters - The Map of request domains to match with associated HttpFilters for filtering responses to those requests.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpRequestFilter requestFilter)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

requestFilter - The filter for HTTP requests.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      ProxyCacheManager cacheManager)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

requestFilter - The filter for HTTP requests.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpRequestFilter requestFilter,
                      HttpResponseFilters responseFilters)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

requestFilter - The filter for HTTP requests.

responseFilters - HTTP filters to apply.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpRequestFilter requestFilter,
                      org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory,
                      org.jboss.netty.util.Timer timer,
                      org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory)

Parameters:

port - The port the server should run on.

requestFilter - Optional filter for modifying incoming requests. Often null.

clientChannelFactory - The factory for creating outgoing channels to external sites.

timer - The global timer for timing out idle connections.

serverChannelFactory - The factory for creating listening channels for incoming connections.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpResponseFilters responseFilters,
                      ChainProxyManager chainProxyManager,
                      HandshakeHandlerFactory handshakeHandlerFactory,
                      HttpRequestFilter requestFilter)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

responseFilters - The Map of request domains to match with associated HttpFilters for filtering responses to those requests.

chainProxyManager - The proxy to send requests to if chaining proxies. Typically null.

ksm - The key manager if running the proxy over SSL.

requestFilter - Optional filter for modifying incoming requests. Often null.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpResponseFilters responseFilters,
                      ChainProxyManager chainProxyManager,
                      HandshakeHandlerFactory handshakeHandlerFactory,
                      HttpRequestFilter requestFilter,
                      org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory,
                      org.jboss.netty.util.Timer timer,
                      org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

responseFilters - The Map of request domains to match with associated HttpFilters for filtering responses to those requests.

chainProxyManager - The proxy to send requests to if chaining proxies. Typically null.

ksm - The key manager if running the proxy over SSL.

requestFilter - Optional filter for modifying incoming requests. Often null.

clientChannelFactory - The factory for creating outgoing channels to external sites.

timer - The global timer for timing out idle connections.

serverChannelFactory - The factory for creating listening channels for incoming connections.

DefaultHttpProxyServer

public DefaultHttpProxyServer(int port,
                      HttpResponseFilters responseFilters,
                      ChainProxyManager chainProxyManager,
                      HandshakeHandlerFactory handshakeHandlerFactory,
                      HttpRequestFilter requestFilter,
                      org.jboss.netty.channel.socket.ClientSocketChannelFactory clientChannelFactory,
                      org.jboss.netty.util.Timer timer,
                      org.jboss.netty.channel.socket.ServerSocketChannelFactory serverChannelFactory,
                      ProxyCacheManager cacheManager)

Creates a new proxy server.

Parameters:

port - The port the server should run on.

responseFilters - The Map of request domains to match with associated HttpFilters for filtering responses to those requests.

chainProxyManager - The proxy to send requests to if chaining proxies. Typically null.

ksm - The key manager if running the proxy over SSL.

requestFilter - Optional filter for modifying incoming requests. Often null.

clientChannelFactory - The factory for creating outgoing channels to external sites.

timer - The global timer for timing out idle connections.

serverChannelFactory - The factory for creating listening channels for incoming connections.

Method Detail

start

public void start()

Description copied from interface: HttpProxyServer

Starts the server.

Specified by:

start in interface HttpProxyServer

start

public void start(boolean localOnly,
         boolean anyAddress)

Description copied from interface: HttpProxyServer

Starts the server.

Specified by:

start in interface HttpProxyServer

Parameters:

localOnly - If true, the server will only allow connections from the local computer. This can significantly improve security in some cases.

anyAddress - Whether or not to bind to "any" address - 0.0.0.0. This is the default.

stop

public void stop()

Description copied from interface: HttpProxyServer

Stops the server.

Specified by:

stop in interface HttpProxyServer

addProxyAuthenticationHandler

public void addProxyAuthenticationHandler(ProxyAuthorizationHandler pah)

Description copied from interface: HttpProxyServer

Adds a new handler for proxy authentication. Handlers are called in the order they're added. If one handler accepts the user's credentials, it passes them on to the next handler.

Specified by:

addProxyAuthenticationHandler in interface HttpProxyServer

Parameters:

pah - The new authentication handler.