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 DefaultHttpProxyServerBootstrap#start(). For example:

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

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.
protected void	closeAllChannels(boolean graceful) Closes all channels opened by this proxy server.
protected void	doStop(boolean graceful) Performs cleanup necessary to stop the server.
protected Collection<ActivityTracker>	getActivityTrackers()
protected ChainedProxyManager	getChainProxyManager()
int	getConnectTimeout() Returns the maximum time to wait, in milliseconds, to connect to a server.
HttpFiltersSource	getFiltersSource()
int	getIdleConnectionTimeout()
InetSocketAddress	getListenAddress() Return the address on which this proxy is listening.
InetSocketAddress	getLocalAddress()
int	getMaxChunkSize()
int	getMaxHeaderSize()
int	getMaxInitialLineLength()
protected MitmManager	getMitmManager()
String	getProxyAlias()
protected ProxyAuthenticator	getProxyAuthenticator()
protected io.netty.channel.EventLoopGroup	getProxyToServerWorkerFor(TransportProtocol transportProtocol)
long	getReadThrottle()
HostResolver	getServerResolver()
protected SslEngineSource	getSslEngineSource()
long	getWriteThrottle()
protected void	registerChannel(io.netty.channel.Channel channel) Register a new Channel with this server, for later closing.
void	setConnectTimeout(int connectTimeoutMs) Sets the maximum time to wait, in milliseconds, to connect to a server.
void	setIdleConnectionTimeout(int idleConnectionTimeout)
void	setThrottle(long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond) Set the read/write throttle bandwidths (in bytes/second) for this proxy.
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

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:

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()

Description copied from interface: HttpProxyServer

Returns the maximum time to wait, in milliseconds, to connect to a server.

Specified by:

getConnectTimeout in interface HttpProxyServer

setConnectTimeout

public void setConnectTimeout(int connectTimeoutMs)

Description copied from interface: HttpProxyServer

Sets the maximum time to wait, in milliseconds, to connect to a server.

Specified by:

setConnectTimeout in interface HttpProxyServer

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()

getMaxInitialLineLength

public int getMaxInitialLineLength()

getMaxHeaderSize

public int getMaxHeaderSize()

getMaxChunkSize

public int getMaxChunkSize()

clone

public HttpProxyServerBootstrap clone()

Description copied from interface: HttpProxyServer

Clone the existing server, with a port 1 higher and everything else the same. If the proxy was started with port 0 (JVM-assigned port), the cloned proxy will also use a JVM-assigned port.

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. The server group will not terminate until the original server and all clones terminate.

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

doStop

protected void doStop(boolean graceful)

Performs cleanup necessary to stop the server. Closes all channels opened by the server and unregisters this server from the server group.

Parameters:

graceful - when true, waits for requests to terminate before stopping the server

registerChannel

protected void registerChannel(io.netty.channel.Channel channel)

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

Parameters:

channel -

closeAllChannels

protected void closeAllChannels(boolean graceful)

Closes all channels opened by this proxy server.

Parameters:

graceful - when false, attempts to shutdown all channels immediately and ignores any channel-closing exceptions

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 io.netty.channel.EventLoopGroup getProxyToServerWorkerFor(TransportProtocol transportProtocol)

getProxyAlias

public String getProxyAlias()