Package org.microproxy

Class ProtocolPolicy.Builder

java.lang.Object

org.microproxy.ProtocolPolicy.Builder

Direct Known Subclasses:

Http1PolicyBuilder

Enclosing class:

ProtocolPolicy

public static class ProtocolPolicy.Builder
extends Object

Builds a ProtocolPolicy. Setters overwrite what an earlier call (or preset(org.microproxy.ProtocolPolicy)) set; fields never set are left to what applies below the policy.

Method Summary

Modifier and Type	Method	Description
ProtocolPolicy	build()	The policy set so far.
ProtocolPolicy.Builder	filterConnectAnswer(boolean filter)	Sets ProtocolPolicy.filterConnectAnswer().
ProtocolPolicy.Builder	generatedResponses(GeneratedResponses value)	Sets ProtocolPolicy.generatedResponses().
ProtocolPolicy.Builder	mitmServerHandshake(MitmServerHandshake value)	Sets ProtocolPolicy.mitmServerHandshake().
ProtocolPolicy.Builder	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.
ProtocolPolicy.Builder	proxyProtocolDestination(ProxyProtocolDestination destination)	Sets ProtocolPolicy.proxyProtocolDestination().
ProtocolPolicy.Builder	requestHeadTimeout(Duration timeout)	Sets ProtocolPolicy.requestHeadTimeout().
ProtocolPolicy.Builder	resolveBeforeProxyToServerRequest(boolean resolveFirst)	Sets ProtocolPolicy.resolveBeforeProxyToServerRequest().
ProtocolPolicy.Builder	servePlainHttpAfterConnect(boolean serve)	Sets ProtocolPolicy.servePlainHttpAfterConnect().
ProtocolPolicy.Builder	set(String name, String value)	Sets a field by its configuration name, as the properties file and the command line name them: preset (ProtocolPolicy.preset(String)), resolve_before_proxy_to_server_request, filter_connect_answer, serve_plain_http_after_connect, proxy_protocol_destination ( local_address or server_address), tls_retry_without_sni and generated_responses (GeneratedResponses.parse(java.lang.String)), mitm_server_handshake (MitmServerHandshake.parse(java.lang.String)), request_head_timeout (milliseconds), and for HTTP/1 allow_chunked_length.
ProtocolPolicy.Builder	tlsRetryWithoutSni(boolean retry)	Sets ProtocolPolicy.tlsRetryWithoutSni().

Methods inherited from class java.lang.Object

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

Method Details

preset

public ProtocolPolicy.Builder 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. A builder for other protocols than HTTP/1 leaves the HTTP/1-only fields alone.

Parameters:

preset - the policy whose fields to copy

Returns:

this builder

resolveBeforeProxyToServerRequest

public ProtocolPolicy.Builder resolveBeforeProxyToServerRequest(boolean resolveFirst)

Sets ProtocolPolicy.resolveBeforeProxyToServerRequest().

Parameters:

resolveFirst - whether the server is resolved before proxyToServerRequest

Returns:

this builder

filterConnectAnswer

public ProtocolPolicy.Builder filterConnectAnswer(boolean filter)

Sets ProtocolPolicy.filterConnectAnswer().

Parameters:

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

Returns:

this builder

servePlainHttpAfterConnect

public ProtocolPolicy.Builder servePlainHttpAfterConnect(boolean serve)

Sets ProtocolPolicy.servePlainHttpAfterConnect().

Parameters:

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

Returns:

this builder

proxyProtocolDestination

public ProtocolPolicy.Builder proxyProtocolDestination(ProxyProtocolDestination destination)

Sets ProtocolPolicy.proxyProtocolDestination().

Parameters:

destination - the destination a sent PROXY header names

Returns:

this builder

tlsRetryWithoutSni

public ProtocolPolicy.Builder tlsRetryWithoutSni(boolean retry)

Sets ProtocolPolicy.tlsRetryWithoutSni().

Parameters:

retry - whether to retry without SNI after an unrecognized_name alert

Returns:

this builder

requestHeadTimeout

public ProtocolPolicy.Builder requestHeadTimeout(Duration timeout)

Sets ProtocolPolicy.requestHeadTimeout().

Parameters:

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

Returns:

this builder

generatedResponses

public ProtocolPolicy.Builder generatedResponses(GeneratedResponses value)

Sets ProtocolPolicy.generatedResponses().

Parameters:

value - how proxyToClientResponse treats generated responses

Returns:

this builder

mitmServerHandshake

public ProtocolPolicy.Builder mitmServerHandshake(MitmServerHandshake value)

Sets ProtocolPolicy.mitmServerHandshake().

Parameters:

value - when the server's handshake runs

Returns:

this builder

set

public ProtocolPolicy.Builder set(String name,
 String value)

Sets a field by its configuration name, as the properties file and the command line name them: preset (ProtocolPolicy.preset(String)), resolve_before_proxy_to_server_request, filter_connect_answer, serve_plain_http_after_connect, proxy_protocol_destination ( local_address or server_address), tls_retry_without_sni and generated_responses (GeneratedResponses.parse(java.lang.String)), mitm_server_handshake (MitmServerHandshake.parse(java.lang.String)), request_head_timeout (milliseconds), and for HTTP/1 allow_chunked_length. Booleans are true or false.

Parameters:

name - the field's name (- may stand for _)

value - its value

Returns:

this builder

Throws:

IllegalArgumentException - for an unknown field (or one of another protocol), or a value the field does not take

build

public ProtocolPolicy build()

The policy set so far.

Returns:

the policy