Package org.littleshoot.proxy.impl

Class DefaultHttpProxyServer.DefaultHttpProxyServerBootstrap

java.lang.Object

org.littleshoot.proxy.impl.DefaultHttpProxyServer.DefaultHttpProxyServerBootstrap

All Implemented Interfaces:

HttpProxyServerBootstrap

Enclosing class:

DefaultHttpProxyServer

private static class DefaultHttpProxyServer.DefaultHttpProxyServerBootstrap
extends Object
implements HttpProxyServerBootstrap

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	acceptProxyProtocol
private Collection<ActivityTracker>	activityTrackers
private boolean	allowLocalOnly
private boolean	allowRequestToOriginServer
private boolean	authenticateSslClients
private ChainedProxyManager	chainProxyManager
private int	clientToProxyAcceptorThreads
private int	clientToProxyWorkerThreads
private int	connectTimeout
private HttpFiltersSource	filtersSource
private int	idleConnectionTimeout
private InetSocketAddress	localAddress
private int	maxChunkSize
private int	maxHeaderSize
private int	maxInitialLineLength
private MitmManager	mitmManager
private String	name
private int	port
private String	proxyAlias
private ProxyAuthenticator	proxyAuthenticator
private int	proxyToServerWorkerThreads
private long	readThrottleBytesPerSecond
private InetSocketAddress	requestedAddress
private boolean	sendProxyProtocol
private ServerGroup	serverGroup
private HostResolver	serverResolver
private SslEngineSource	sslEngineSource
private boolean	transparent
private TransportProtocol	transportProtocol
private long	writeThrottleBytesPerSecond

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultHttpProxyServerBootstrap()
private	DefaultHttpProxyServerBootstrap(Properties props)
private	DefaultHttpProxyServerBootstrap(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, String proxyAlias, int maxInitialLineLength, int maxHeaderSize, int maxChunkSize, boolean allowRequestToOriginServer)

Method Summary

Modifier and Type	Method	Description
private DefaultHttpProxyServer	build()
private InetSocketAddress	determineListenAddress()
HttpProxyServerBootstrap	plusActivityTracker(ActivityTracker activityTracker)	Add an ActivityTracker for tracking activity in this proxy.
HttpProxyServer	start()	Build and starts the server.
HttpProxyServerBootstrap	withAcceptProxyProtocol(boolean acceptProxyProtocol)	Specifies if the proxy server should accept a proxy protocol header.
HttpProxyServerBootstrap	withAddress(InetSocketAddress address)	Listen for incoming connections on the given address.
HttpProxyServerBootstrap	withAllowLocalOnly(boolean allowLocalOnly)	Specify whether or not to only allow local connections.
HttpProxyServerBootstrap	withAllowRequestToOriginServer(boolean allowRequestToOriginServer)	When true, the proxy will accept requests that appear to be directed at an origin server (i.e.
HttpProxyServerBootstrap	withAuthenticateSslClients(boolean authenticateSslClients)	Specify whether or not to authenticate inbound SSL clients (only applies if HttpProxyServerBootstrap.withSslEngineSource(SslEngineSource) has been set).
HttpProxyServerBootstrap	withChainProxyManager(ChainedProxyManager chainProxyManager)	Specify a ChainedProxyManager to use for chaining requests to another proxy.
HttpProxyServerBootstrap	withConnectTimeout(int connectTimeout)	Specify the timeout for connecting to the upstream server on a new connection, in milliseconds.
HttpProxyServerBootstrap	withFiltersSource(HttpFiltersSource filtersSource)	Specify a HttpFiltersSource to use for filtering requests and/or responses through this proxy.
HttpProxyServerBootstrap	withIdleConnectionTimeout(int idleConnectionTimeout)	Specify the timeout after which to disconnect idle connections, in seconds.
HttpProxyServerBootstrap	withListenOnAllAddresses(boolean listenOnAllAddresses)	Deprecated.
HttpProxyServerBootstrap	withManInTheMiddle(MitmManager mitmManager)	Specify an MitmManager to use for making this proxy act as an SSL man in the middle
HttpProxyServerBootstrap	withMaxChunkSize(int maxChunkSize)
HttpProxyServerBootstrap	withMaxHeaderSize(int maxHeaderSize)
HttpProxyServerBootstrap	withMaxInitialLineLength(int maxInitialLineLength)
HttpProxyServerBootstrap	withName(String name)	Give the server a name (used for naming threads, useful for logging).
HttpProxyServerBootstrap	withNetworkInterface(InetSocketAddress inetSocketAddress)	All outgoing-communication of the proxy-instance is going' to be routed via the given network-interface
HttpProxyServerBootstrap	withPort(int port)	Listen for incoming connections on the given port.
HttpProxyServerBootstrap	withProxyAlias(String alias)	Sets the alias to use when adding Via headers to incoming and outgoing HTTP messages.
HttpProxyServerBootstrap	withProxyAuthenticator(ProxyAuthenticator proxyAuthenticator)	Specify a ProxyAuthenticator to use for doing basic HTTP authentication of clients.
HttpProxyServerBootstrap	withSendProxyProtocol(boolean sendProxyProtocol)	Specifies if the proxy server should send a proxy protocol header.
HttpProxyServerBootstrap	withServerGroup(ServerGroup group)	Specify a custom ServerGroup to use for managing this server's resources and such.
HttpProxyServerBootstrap	withServerResolver(HostResolver serverResolver)	Specify a custom HostResolver for resolving server addresses.
HttpProxyServerBootstrap	withSslEngineSource(SslEngineSource sslEngineSource)	Specify an SslEngineSource to use for encrypting inbound connections.
HttpProxyServerBootstrap	withThreadPoolConfiguration(ThreadPoolConfiguration configuration)	Set the configuration parameters for the proxy's thread pools.
HttpProxyServerBootstrap	withThrottling(long readThrottleBytesPerSecond, long writeThrottleBytesPerSecond)	Specify the read and/or write bandwidth throttles for this proxy server.
HttpProxyServerBootstrap	withTransparent(boolean transparent)	Specify whether or not to run this proxy as a transparent proxy.
HttpProxyServerBootstrap	withTransportProtocol(TransportProtocol transportProtocol)	Specify the TransportProtocol to use for incoming connections.
HttpProxyServerBootstrap	withUseDnsSec(boolean useDnsSec)	Specify whether or not to use secure DNS lookups for outbound connections.

Methods inherited from class java.lang.Object

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

Field Detail

name

private String name

serverGroup

private ServerGroup serverGroup

transportProtocol

private TransportProtocol transportProtocol

requestedAddress

private InetSocketAddress requestedAddress

port

private int port

allowLocalOnly

private boolean allowLocalOnly

sslEngineSource

private SslEngineSource sslEngineSource

authenticateSslClients

private boolean authenticateSslClients

proxyAuthenticator

private ProxyAuthenticator proxyAuthenticator

chainProxyManager

private ChainedProxyManager chainProxyManager

mitmManager

private MitmManager mitmManager

filtersSource

private HttpFiltersSource filtersSource

transparent

private boolean transparent

idleConnectionTimeout

private int idleConnectionTimeout

activityTrackers

private final Collection<ActivityTracker> activityTrackers

connectTimeout

private int connectTimeout

serverResolver

private HostResolver serverResolver

readThrottleBytesPerSecond

private long readThrottleBytesPerSecond

writeThrottleBytesPerSecond

private long writeThrottleBytesPerSecond

localAddress

private InetSocketAddress localAddress

proxyAlias

private String proxyAlias

clientToProxyAcceptorThreads

private int clientToProxyAcceptorThreads

clientToProxyWorkerThreads

private int clientToProxyWorkerThreads

proxyToServerWorkerThreads

private int proxyToServerWorkerThreads

maxInitialLineLength

private int maxInitialLineLength

maxHeaderSize

private int maxHeaderSize

maxChunkSize

private int maxChunkSize

allowRequestToOriginServer

private boolean allowRequestToOriginServer

acceptProxyProtocol

private boolean acceptProxyProtocol

sendProxyProtocol

private boolean sendProxyProtocol

Constructor Detail

DefaultHttpProxyServerBootstrap

private DefaultHttpProxyServerBootstrap()

DefaultHttpProxyServerBootstrap

private DefaultHttpProxyServerBootstrap(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,
                                        String proxyAlias,
                                        int maxInitialLineLength,
                                        int maxHeaderSize,
                                        int maxChunkSize,
                                        boolean allowRequestToOriginServer)

DefaultHttpProxyServerBootstrap

private DefaultHttpProxyServerBootstrap(Properties props)

Method Detail

withName

public HttpProxyServerBootstrap withName(String name)

Description copied from interface: HttpProxyServerBootstrap

Give the server a name (used for naming threads, useful for logging).

Default = LittleProxy

Specified by:

withName in interface HttpProxyServerBootstrap

withTransportProtocol

public HttpProxyServerBootstrap withTransportProtocol(TransportProtocol transportProtocol)

Description copied from interface: HttpProxyServerBootstrap

Specify the TransportProtocol to use for incoming connections.

Default = TCP

Specified by:

withTransportProtocol in interface HttpProxyServerBootstrap

withAddress

public HttpProxyServerBootstrap withAddress(InetSocketAddress address)

Description copied from interface: HttpProxyServerBootstrap

Listen for incoming connections on the given address.

Default = [bound ip]:8080

Specified by:

withAddress in interface HttpProxyServerBootstrap

withPort

public HttpProxyServerBootstrap withPort(int port)

Description copied from interface: HttpProxyServerBootstrap

Listen for incoming connections on the given port.

Default = 8080

Specified by:

withPort in interface HttpProxyServerBootstrap

withNetworkInterface

public HttpProxyServerBootstrap withNetworkInterface(InetSocketAddress inetSocketAddress)

Description copied from interface: HttpProxyServerBootstrap

All outgoing-communication of the proxy-instance is going' to be routed via the given network-interface

Specified by:

withNetworkInterface in interface HttpProxyServerBootstrap

Parameters:

inetSocketAddress - to be used for outgoing communication

withProxyAlias

public HttpProxyServerBootstrap withProxyAlias(String alias)

Description copied from interface: HttpProxyServerBootstrap

Sets the alias to use when adding Via headers to incoming and outgoing HTTP messages. The alias may be any pseudonym, or if not specified, defaults to the hostname of the local machine. See RFC 7230, section 5.7.1.

Specified by:

withProxyAlias in interface HttpProxyServerBootstrap

Parameters:

alias - the pseudonym to add to Via headers

withAllowLocalOnly

public HttpProxyServerBootstrap withAllowLocalOnly(boolean allowLocalOnly)

Description copied from interface: HttpProxyServerBootstrap

Specify whether or not to only allow local connections.

Default = true

Specified by:

withAllowLocalOnly in interface HttpProxyServerBootstrap

withListenOnAllAddresses

@Deprecated
public HttpProxyServerBootstrap withListenOnAllAddresses(boolean listenOnAllAddresses)

Deprecated.

Description copied from interface: HttpProxyServerBootstrap

This method has no effect and will be removed in a future release.

Specified by:

withListenOnAllAddresses in interface HttpProxyServerBootstrap

withSslEngineSource

public HttpProxyServerBootstrap withSslEngineSource(SslEngineSource sslEngineSource)

Description copied from interface: HttpProxyServerBootstrap

Specify an SslEngineSource to use for encrypting inbound connections. Enabling this will enable SSL client authentication by default (see HttpProxyServerBootstrap.withAuthenticateSslClients(boolean))

Default = null

Note - This and HttpProxyServerBootstrap.withManInTheMiddle(MitmManager) are mutually exclusive.

Specified by:

withSslEngineSource in interface HttpProxyServerBootstrap

withAuthenticateSslClients

public HttpProxyServerBootstrap withAuthenticateSslClients(boolean authenticateSslClients)

Description copied from interface: HttpProxyServerBootstrap

Specify whether or not to authenticate inbound SSL clients (only applies if HttpProxyServerBootstrap.withSslEngineSource(SslEngineSource) has been set).

Default = true

Specified by:

withAuthenticateSslClients in interface HttpProxyServerBootstrap

withProxyAuthenticator

public HttpProxyServerBootstrap withProxyAuthenticator(ProxyAuthenticator proxyAuthenticator)

Description copied from interface: HttpProxyServerBootstrap

Specify a ProxyAuthenticator to use for doing basic HTTP authentication of clients.

Default = null

Specified by:

withProxyAuthenticator in interface HttpProxyServerBootstrap

withChainProxyManager

public HttpProxyServerBootstrap withChainProxyManager(ChainedProxyManager chainProxyManager)

Description copied from interface: HttpProxyServerBootstrap

Specify a ChainedProxyManager to use for chaining requests to another proxy.

Default = null

Specified by:

withChainProxyManager in interface HttpProxyServerBootstrap

withManInTheMiddle

public HttpProxyServerBootstrap withManInTheMiddle(MitmManager mitmManager)

Description copied from interface: HttpProxyServerBootstrap

Specify an MitmManager to use for making this proxy act as an SSL man in the middle

Default = null

Note - This and HttpProxyServerBootstrap.withSslEngineSource(SslEngineSource) are mutually exclusive.

Specified by:

withManInTheMiddle in interface HttpProxyServerBootstrap

withFiltersSource

public HttpProxyServerBootstrap withFiltersSource(HttpFiltersSource filtersSource)

Description copied from interface: HttpProxyServerBootstrap

Specify a HttpFiltersSource to use for filtering requests and/or responses through this proxy.

Default = null

Specified by:

withFiltersSource in interface HttpProxyServerBootstrap

withUseDnsSec

public HttpProxyServerBootstrap withUseDnsSec(boolean useDnsSec)

Description copied from interface: HttpProxyServerBootstrap

Specify whether or not to use secure DNS lookups for outbound connections.

Default = false

Specified by:

withUseDnsSec in interface HttpProxyServerBootstrap

withTransparent

public HttpProxyServerBootstrap withTransparent(boolean transparent)

Description copied from interface: HttpProxyServerBootstrap

Specify whether or not to run this proxy as a transparent proxy.

Default = false

Specified by:

withTransparent in interface HttpProxyServerBootstrap

withIdleConnectionTimeout

public HttpProxyServerBootstrap withIdleConnectionTimeout(int idleConnectionTimeout)

Description copied from interface: HttpProxyServerBootstrap

Specify the timeout after which to disconnect idle connections, in seconds.

Default = 70

Specified by:

withIdleConnectionTimeout in interface HttpProxyServerBootstrap

withConnectTimeout

public HttpProxyServerBootstrap withConnectTimeout(int connectTimeout)

Description copied from interface: HttpProxyServerBootstrap

Specify the timeout for connecting to the upstream server on a new connection, in milliseconds.

Default = 40000

Specified by:

withConnectTimeout in interface HttpProxyServerBootstrap

withServerResolver

public HttpProxyServerBootstrap withServerResolver(HostResolver serverResolver)

Description copied from interface: HttpProxyServerBootstrap

Specify a custom HostResolver for resolving server addresses.

Specified by:

withServerResolver in interface HttpProxyServerBootstrap

withServerGroup

public HttpProxyServerBootstrap withServerGroup(ServerGroup group)

Description copied from interface: HttpProxyServerBootstrap

Specify a custom ServerGroup to use for managing this server's resources and such. If one isn't provided, a default one will be created using the ThreadPoolConfiguration provided

Specified by:

withServerGroup in interface HttpProxyServerBootstrap

Parameters:

group - A custom server group

plusActivityTracker

public HttpProxyServerBootstrap plusActivityTracker(ActivityTracker activityTracker)

Description copied from interface: HttpProxyServerBootstrap

Add an ActivityTracker for tracking activity in this proxy.

Specified by:

plusActivityTracker in interface HttpProxyServerBootstrap

withThrottling

public HttpProxyServerBootstrap withThrottling(long readThrottleBytesPerSecond,
                                               long writeThrottleBytesPerSecond)

Description copied from interface: HttpProxyServerBootstrap

Specify the read and/or write bandwidth throttles for this proxy server. 0 indicates not throttling.

Specified by:

withThrottling in interface HttpProxyServerBootstrap

withMaxInitialLineLength

public HttpProxyServerBootstrap withMaxInitialLineLength(int maxInitialLineLength)

Specified by:

withMaxInitialLineLength in interface HttpProxyServerBootstrap

withMaxHeaderSize

public HttpProxyServerBootstrap withMaxHeaderSize(int maxHeaderSize)

Specified by:

withMaxHeaderSize in interface HttpProxyServerBootstrap

withMaxChunkSize

public HttpProxyServerBootstrap withMaxChunkSize(int maxChunkSize)

Specified by:

withMaxChunkSize in interface HttpProxyServerBootstrap

withAllowRequestToOriginServer

public HttpProxyServerBootstrap withAllowRequestToOriginServer(boolean allowRequestToOriginServer)

Description copied from interface: HttpProxyServerBootstrap

When true, the proxy will accept requests that appear to be directed at an origin server (i.e. the URI in the HTTP request will contain an origin-form, rather than an absolute-form, as specified in RFC 7230, section 5.3). This is useful when the proxy is acting as a gateway/reverse proxy. Note: This feature should not be enabled when running as a forward proxy; doing so may cause an infinite loop if the client requests the URI of the proxy.

Specified by:

withAllowRequestToOriginServer in interface HttpProxyServerBootstrap

Parameters:

allowRequestToOriginServer - when true, the proxy will accept origin-form HTTP requests

withAcceptProxyProtocol

public HttpProxyServerBootstrap withAcceptProxyProtocol(boolean acceptProxyProtocol)

Description copied from interface: HttpProxyServerBootstrap

Specifies if the proxy server should accept a proxy protocol header. Once set it works with request that include a proxy protocol header. The proxy server reads an incoming proxy protocol header from the client.

Specified by:

withAcceptProxyProtocol in interface HttpProxyServerBootstrap

Parameters:

acceptProxyProtocol - when true, the proxy will accept a proxy protocol header

withSendProxyProtocol

public HttpProxyServerBootstrap withSendProxyProtocol(boolean sendProxyProtocol)

Description copied from interface: HttpProxyServerBootstrap

Specifies if the proxy server should send a proxy protocol header.

Specified by:

withSendProxyProtocol in interface HttpProxyServerBootstrap

Parameters:

sendProxyProtocol - when true, the proxy will send a proxy protocol header

start

public HttpProxyServer start()

Description copied from interface: HttpProxyServerBootstrap

Build and starts the server.

Specified by:

start in interface HttpProxyServerBootstrap

Returns:

the newly built and started server

withThreadPoolConfiguration

public HttpProxyServerBootstrap withThreadPoolConfiguration(ThreadPoolConfiguration configuration)

Description copied from interface: HttpProxyServerBootstrap

Set the configuration parameters for the proxy's thread pools.

Specified by:

withThreadPoolConfiguration in interface HttpProxyServerBootstrap

Parameters:

configuration - thread pool configuration

Returns:

proxy server bootstrap for chaining

build

private DefaultHttpProxyServer build()

determineListenAddress

private InetSocketAddress determineListenAddress()