org.littleshoot.proxy.impl

Class DefaultHttpProxyServer

java.lang.Object

org.littleshoot.proxy.impl.DefaultHttpProxyServer

All Implemented Interfaces:

HttpProxyServer

public class DefaultHttpProxyServer
extends Object
implements HttpProxyServer

Primary implementation of an HttpProxyServer.

DefaultHttpProxyServer is bootstrapped by calling bootstrap() or bootstrapFromFile(String), and then calling DefaultHttpProxyServer.DefaultHttpProxyServerBootstrap.start(). For example:

 DefaultHttpProxyServer server =
         DefaultHttpProxyServer
                 .bootstrap()
                 .withPort(8090)
                 .start();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultHttpProxyServer.DefaultHttpProxyServerBootstrap
private static class	DefaultHttpProxyServer.ServerGroup Represents a group of servers that share thread pools.

Field Summary

Fields

Modifier and Type	Field and Description
private Collection<ActivityTracker>	activityTrackers Track all ActivityTrackers for tracking proxying activity.
private boolean	authenticateSslClients
private InetSocketAddress	boundAddress
private ChainedProxyManager	chainProxyManager
private int	connectTimeout
private HttpFiltersSource	filtersSource
private GlobalTrafficShapingHandler	globalTrafficShapingHandler
private int	idleConnectionTimeout
private InetSocketAddress	localAddress
private static org.slf4j.Logger	LOG
private MitmManager	mitmManager
private ProxyAuthenticator	proxyAuthenticator
private InetSocketAddress	requestedAddress
private DefaultHttpProxyServer.ServerGroup	serverGroup Our DefaultHttpProxyServer.ServerGroup.
private HostResolver	serverResolver
private SslEngineSource	sslEngineSource
private static long	TRAFFIC_SHAPING_CHECK_INTERVAL_MS The interval in ms at which the GlobalTrafficShapingHandler will run to compute and throttle the proxy-to-server bandwidth.
private boolean	transparent
private TransportProtocol	transportProtocol

Constructor Summary

Constructors

Modifier

Constructor and Description

private

DefaultHttpProxyServer(DefaultHttpProxyServer.ServerGroup serverGroup, TransportProtocol transportProtocol, InetSocketAddress requestedAddress, SslEngineSource sslEngineSource, boolean authenticateSslClients, ProxyAuthenticator proxyAuthenticator, ChainedProxyManager chainProxyManager, MitmManager mitmManager, HttpFiltersSource filtersSource, boolean transparent, int idleConnectionTimeout, Collection<ActivityTracker> activityTrackers, int connectTimeout, HostResolver serverResolver, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond, InetSocketAddress localAddress) Creates a new proxy server.

Method Summary

Modifier and Type	Method and Description
void	abort() Stops the server and all related clones immediately, without waiting for traffic to stop.
static HttpProxyServerBootstrap	bootstrap() Bootstrap a new DefaultHttpProxyServer starting from scratch.
static HttpProxyServerBootstrap	bootstrapFromFile(String path) Bootstrap a new DefaultHttpProxyServer using defaults from the given file.
HttpProxyServerBootstrap	clone() Clone the existing server, with a port 1 higher and everything else the same.
private GlobalTrafficShapingHandler	createGlobalTrafficShapingHandler(TransportProtocol transportProtocol, long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond) Creates a new GlobalTrafficShapingHandler for this HttpProxyServer, using this proxy's proxyToServerEventLoop.
private void	doStart()
protected Collection<ActivityTracker>	getActivityTrackers()
protected ChainedProxyManager	getChainProxyManager()
int	getConnectTimeout()
HttpFiltersSource	getFiltersSource()
int	getIdleConnectionTimeout()
InetSocketAddress	getListenAddress() Return the address on which this proxy is listening.
InetSocketAddress	getLocalAddress()
protected MitmManager	getMitmManager()
protected ProxyAuthenticator	getProxyAuthenticator()
protected EventLoopGroup	getProxyToServerWorkerFor(TransportProtocol transportProtocol)
long	getReadThrottle()
HostResolver	getServerResolver()
protected SslEngineSource	getSslEngineSource()
long	getWriteThrottle()
(package private) boolean	isTransparent()
protected void	registerChannel(Channel channel) Register a new Channel with this server, for later closing.
void	setIdleConnectionTimeout(int idleConnectionTimeout)
void	setThrottle(long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond) Set the read/write throttle bandwidths (in bytes/second) for this proxy.
private HttpProxyServer	start()
void	stop() Stops the server and all related clones.

Methods inherited from class java.lang.Object

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

Field Detail

TRAFFIC_SHAPING_CHECK_INTERVAL_MS

private static final long TRAFFIC_SHAPING_CHECK_INTERVAL_MS

The interval in ms at which the GlobalTrafficShapingHandler will run to compute and throttle the proxy-to-server bandwidth.

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

serverGroup

private final DefaultHttpProxyServer.ServerGroup serverGroup

Our DefaultHttpProxyServer.ServerGroup. Multiple proxy servers can share the same ServerGroup in order to reuse threads and other such resources.

transportProtocol

private final TransportProtocol transportProtocol

requestedAddress

private final InetSocketAddress requestedAddress

localAddress

private volatile InetSocketAddress localAddress

boundAddress

private volatile InetSocketAddress boundAddress

sslEngineSource

private final SslEngineSource sslEngineSource

authenticateSslClients

private final boolean authenticateSslClients

proxyAuthenticator

private final ProxyAuthenticator proxyAuthenticator

chainProxyManager

private final ChainedProxyManager chainProxyManager

mitmManager

private final MitmManager mitmManager

filtersSource

private final HttpFiltersSource filtersSource

transparent

private final boolean transparent

connectTimeout

private final int connectTimeout

idleConnectionTimeout

private volatile int idleConnectionTimeout

serverResolver

private final HostResolver serverResolver

globalTrafficShapingHandler

private volatile GlobalTrafficShapingHandler globalTrafficShapingHandler

activityTrackers

private final Collection<ActivityTracker> activityTrackers

Track all ActivityTrackers for tracking proxying activity.

Constructor Detail

DefaultHttpProxyServer

private DefaultHttpProxyServer(DefaultHttpProxyServer.ServerGroup serverGroup,
                               TransportProtocol transportProtocol,
                               InetSocketAddress requestedAddress,
                               SslEngineSource sslEngineSource,
                               boolean authenticateSslClients,
                               ProxyAuthenticator proxyAuthenticator,
                               ChainedProxyManager chainProxyManager,
                               MitmManager mitmManager,
                               HttpFiltersSource filtersSource,
                               boolean transparent,
                               int idleConnectionTimeout,
                               Collection<ActivityTracker> activityTrackers,
                               int connectTimeout,
                               HostResolver serverResolver,
                               long readThrottleBytesPerSecond,
                               long writeThrottleBytesPerSecond,
                               InetSocketAddress localAddress)

Creates a new proxy server.

Parameters:

serverGroup - our ServerGroup for shared thread pools and such

transportProtocol - The protocol to use for data transport

requestedAddress - The address on which this server will listen

sslEngineSource - (optional) if specified, this Proxy will encrypt inbound connections from clients using an SSLEngine obtained from this SslEngineSource.

authenticateSslClients - Indicate whether or not to authenticate clients when using SSL

proxyAuthenticator - (optional) If specified, requests to the proxy will be authenticated using HTTP BASIC authentication per the provided ProxyAuthenticator

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

mitmManager - The MitmManager to use for man in the middle'ing CONNECT requests

filtersSource - Source for HttpFilters

transparent - If true, this proxy will run as a transparent proxy (not touching requests and responses).

idleConnectionTimeout - The timeout (in seconds) for auto-closing idle connections.

activityTrackers - for tracking activity on this proxy

connectTimeout - number of milliseconds to wait to connect to the upstream server

serverResolver - the HostResolver to use for resolving server addresses

readThrottleBytesPerSecond - read throttle bandwidth

writeThrottleBytesPerSecond - write throttle bandwidth

Method Detail

bootstrap

public static HttpProxyServerBootstrap bootstrap()

Bootstrap a new DefaultHttpProxyServer starting from scratch.

Returns:

bootstrapFromFile

public static HttpProxyServerBootstrap bootstrapFromFile(String path)

Bootstrap a new DefaultHttpProxyServer using defaults from the given file.

Parameters:

path -

Returns:

createGlobalTrafficShapingHandler

private GlobalTrafficShapingHandler createGlobalTrafficShapingHandler(TransportProtocol transportProtocol,
                                                                      long readThrottleBytesPerSecond,
                                                                      long writeThrottleBytesPerSecond)

Creates a new GlobalTrafficShapingHandler for this HttpProxyServer, using this proxy's proxyToServerEventLoop.

Parameters:

transportProtocol -

readThrottleBytesPerSecond -

writeThrottleBytesPerSecond -

Returns:

isTransparent

boolean isTransparent()

getIdleConnectionTimeout

public int getIdleConnectionTimeout()

Specified by:

getIdleConnectionTimeout in interface HttpProxyServer

setIdleConnectionTimeout

public void setIdleConnectionTimeout(int idleConnectionTimeout)

Specified by:

setIdleConnectionTimeout in interface HttpProxyServer

getConnectTimeout

public int getConnectTimeout()

getServerResolver

public HostResolver getServerResolver()

getLocalAddress

public InetSocketAddress getLocalAddress()

getListenAddress

public InetSocketAddress getListenAddress()

Description copied from interface: HttpProxyServer

Return the address on which this proxy is listening.

Specified by:

getListenAddress in interface HttpProxyServer

Returns:

setThrottle

public void setThrottle(long readThrottleBytesPerSecond,
                        long writeThrottleBytesPerSecond)

Description copied from interface: HttpProxyServer

Set the read/write throttle bandwidths (in bytes/second) for this proxy.

Specified by:

setThrottle in interface HttpProxyServer

getReadThrottle

public long getReadThrottle()

getWriteThrottle

public long getWriteThrottle()

clone

public HttpProxyServerBootstrap clone()

Description copied from interface: HttpProxyServer

Clone the existing server, with a port 1 higher and everything else the same.

The new server will share event loops with the original server. The event loops will use whatever name was given to the first server in the clone group.

Specified by:

clone in interface HttpProxyServer

Overrides:

clone in class Object

Returns:

a bootstrap that allows customizing and starting the cloned server

stop

public void stop()

Description copied from interface: HttpProxyServer

Stops the server and all related clones. Waits for traffic to stop before shutting down.

Specified by:

stop in interface HttpProxyServer

abort

public void abort()

Description copied from interface: HttpProxyServer

Stops the server and all related clones immediately, without waiting for traffic to stop.

Specified by:

abort in interface HttpProxyServer

start

private HttpProxyServer start()

doStart

private void doStart()

registerChannel

protected void registerChannel(Channel channel)

Register a new Channel with this server, for later closing.

Parameters:

channel -

getChainProxyManager

protected ChainedProxyManager getChainProxyManager()

getMitmManager

protected MitmManager getMitmManager()

getSslEngineSource

protected SslEngineSource getSslEngineSource()

getProxyAuthenticator

protected ProxyAuthenticator getProxyAuthenticator()

getFiltersSource

public HttpFiltersSource getFiltersSource()

getActivityTrackers

protected Collection<ActivityTracker> getActivityTrackers()

getProxyToServerWorkerFor

protected EventLoopGroup getProxyToServerWorkerFor(TransportProtocol transportProtocol)