Package org.microproxy

Class Http1PolicyBuilder

java.lang.Object

org.microproxy.ProtocolPolicy.Builder

org.microproxy.Http1PolicyBuilder

public final class Http1PolicyBuilder
extends ProtocolPolicy.Builder

Builds the ProtocolPolicy of HTTP/1.x clients (HttpProxyServerBootstrap.onHttp1(java.util.function.Consumer<org.microproxy.Http1PolicyBuilder>)): the fields every protocol has, and HTTP/1-specific fields such as requestHeadTimeout(java.time.Duration) and allowChunkedLength(boolean).

Constructor Summary

Constructors

Constructor	Description
Http1PolicyBuilder()	An empty builder: every field left to what applies below the policy.

Method Summary

Modifier and Type	Method	Description
Http1PolicyBuilder	allowChunkedLength(boolean allow)	Sets ProtocolPolicy.allowChunkedLength(): whether an HTTP/1.1 request with both Transfer-Encoding and Content-Length is accepted, its Content-Length dropped and the connection closed after the response, as HttpProxyServerBootstrap.withAllowChunkedLength(boolean) says for the whole server.
Http1PolicyBuilder	filterConnectAnswer(boolean filter)	Sets ProtocolPolicy.filterConnectAnswer().
Http1PolicyBuilder	generatedResponses(GeneratedResponses value)	Sets ProtocolPolicy.generatedResponses().
Http1PolicyBuilder	mitmServerHandshake(MitmServerHandshake value)	Sets ProtocolPolicy.mitmServerHandshake().
Http1PolicyBuilder	preset(ProtocolPolicy preset)	Sets every field that preset sets (such as ProtocolPolicy.littleProxy()), overwriting what was set before; setters called after it overwrite it in turn.
Http1PolicyBuilder	proxyProtocolDestination(ProxyProtocolDestination destination)	Sets ProtocolPolicy.proxyProtocolDestination().
Http1PolicyBuilder	requestHeadTimeout(Duration timeout)	Sets ProtocolPolicy.requestHeadTimeout().
Http1PolicyBuilder	resolveBeforeProxyToServerRequest(boolean resolveFirst)	Sets ProtocolPolicy.resolveBeforeProxyToServerRequest().
Http1PolicyBuilder	servePlainHttpAfterConnect(boolean serve)	Sets ProtocolPolicy.servePlainHttpAfterConnect().
Http1PolicyBuilder	set(String name, String value)	Sets a field by its configuration name, as ProtocolPolicy.Builder.set(java.lang.String, java.lang.String) does, and also allow_chunked_length.
Http1PolicyBuilder	tlsRetryWithoutSni(boolean retry)	Sets ProtocolPolicy.tlsRetryWithoutSni().

Methods inherited from class org.microproxy.ProtocolPolicy.Builder

build

Methods inherited from class java.lang.Object

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

Constructor Details

Http1PolicyBuilder

public Http1PolicyBuilder()

An empty builder: every field left to what applies below the policy.

Method Details

preset

public Http1PolicyBuilder preset(ProtocolPolicy preset)

Description copied from class: ProtocolPolicy.Builder

Sets every field that preset sets (such as ProtocolPolicy.littleProxy()), overwriting what was set before; setters called after it overwrite it in turn. A builder for other protocols than HTTP/1 leaves the HTTP/1-only fields alone.

Overrides:

preset in class ProtocolPolicy.Builder

Parameters:

preset - the policy whose fields to copy

Returns:

this builder

resolveBeforeProxyToServerRequest

public Http1PolicyBuilder resolveBeforeProxyToServerRequest(boolean resolveFirst)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.resolveBeforeProxyToServerRequest().

Overrides:

resolveBeforeProxyToServerRequest in class ProtocolPolicy.Builder

Parameters:

resolveFirst - whether the server is resolved before proxyToServerRequest

Returns:

this builder

filterConnectAnswer

public Http1PolicyBuilder filterConnectAnswer(boolean filter)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.filterConnectAnswer().

Overrides:

filterConnectAnswer in class ProtocolPolicy.Builder

Parameters:

filter - whether the CONNECT's 200 goes through response filters

Returns:

this builder

servePlainHttpAfterConnect

public Http1PolicyBuilder servePlainHttpAfterConnect(boolean serve)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.servePlainHttpAfterConnect().

Overrides:

servePlainHttpAfterConnect in class ProtocolPolicy.Builder

Parameters:

serve - whether plain HTTP after a CONNECT is served as HTTP

Returns:

this builder

proxyProtocolDestination

public Http1PolicyBuilder proxyProtocolDestination(ProxyProtocolDestination destination)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.proxyProtocolDestination().

Overrides:

proxyProtocolDestination in class ProtocolPolicy.Builder

Parameters:

destination - the destination a sent PROXY header names

Returns:

this builder

tlsRetryWithoutSni

public Http1PolicyBuilder tlsRetryWithoutSni(boolean retry)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.tlsRetryWithoutSni().

Overrides:

tlsRetryWithoutSni in class ProtocolPolicy.Builder

Parameters:

retry - whether to retry without SNI after an unrecognized_name alert

Returns:

this builder

requestHeadTimeout

public Http1PolicyBuilder requestHeadTimeout(Duration timeout)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.requestHeadTimeout().

Overrides:

requestHeadTimeout in class ProtocolPolicy.Builder

Parameters:

timeout - the maximum time for an HTTP/1 request head; zero disables the deadline

Returns:

this builder

generatedResponses

public Http1PolicyBuilder generatedResponses(GeneratedResponses value)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.generatedResponses().

Overrides:

generatedResponses in class ProtocolPolicy.Builder

Parameters:

value - how proxyToClientResponse treats generated responses

Returns:

this builder

mitmServerHandshake

public Http1PolicyBuilder mitmServerHandshake(MitmServerHandshake value)

Description copied from class: ProtocolPolicy.Builder

Sets ProtocolPolicy.mitmServerHandshake().

Overrides:

mitmServerHandshake in class ProtocolPolicy.Builder

Parameters:

value - when the server's handshake runs

Returns:

this builder

allowChunkedLength

public Http1PolicyBuilder allowChunkedLength(boolean allow)

Sets ProtocolPolicy.allowChunkedLength(): whether an HTTP/1.1 request with both Transfer-Encoding and Content-Length is accepted, its Content-Length dropped and the connection closed after the response, as HttpProxyServerBootstrap.withAllowChunkedLength(boolean) says for the whole server.

Parameters:

allow - whether such requests are accepted

Returns:

this builder

set

public Http1PolicyBuilder set(String name,
 String value)

Sets a field by its configuration name, as ProtocolPolicy.Builder.set(java.lang.String, java.lang.String) does, and also allow_chunked_length.

Overrides:

set in class ProtocolPolicy.Builder

Parameters:

name - the field's name

value - its value

Returns:

this builder

Throws:

IllegalArgumentException - for an unknown field, or a value the field does not take