Uses of Package
org.microproxy

Packages that use org.microproxy

Package	Description
org.microproxy
org.microproxy.cache
org.microproxy.dns
org.microproxy.extras
org.microproxy.frames
org.microproxy.otel	OpenTelemetry for MicroProxy, with no dependencies but the JDK: W3C Trace Context, B3 and Jaeger propagation (Propagators), sampling (Sampler), a SERVER span per exchange and a CLIENT span per attempt to reach the server, INTERNAL spans for tunnels and flows, and OTLP/HTTP export of traces, metrics (the proxy's StatsRegistry) and access logs, as protobuf or JSON (Telemetry).
org.microproxy.quic
org.microproxy.starlark
org.microproxy.tcp
org.microproxy.tls
org.microproxy.udp
org.microproxy.warc

Classes in org.microproxy used by org.microproxy

Class	Description
ActivityTracker	Observes proxy activity, e.g. for metrics or access logs.
AuthResult	What a ProxyAuthenticator decided about a request.
ChainedProxy	An upstream proxy that requests are forwarded through.
ChainedProxyManager	Chooses upstream proxies for each request.
ChainedProxyType	The protocol spoken to an upstream (chained) proxy.
ClientDetails	What the proxy knows about a client: its address and, once authenticated, its user name.
ClientHello	A client's TLS ClientHello, the first message of a handshake, as the proxy read it before deciding whether to intercept a connection: after a CONNECT is accepted, and first thing on a connection to a transparent listener.
DrainStrategy	How a draining proxy (HttpProxyServer.drain(java.time.Duration)) tells its clients to go elsewhere, as Envoy's --drain-strategy: each new request may be answered with Connection: close (HTTP/1) or make the proxy send GOAWAY (HTTP/2, HTTP/3) on its connection.
FailureResponder	Makes the proxy's own answer when a request fails (ProxyFailure), e.g. to send branded error pages or JSON instead of the default plain-text body.
FlowContext	Information about the client side of a proxied flow.
FlowRecord	What an access log needs to know about one finished exchange or flow, handed to ActivityTracker.flowEnded(org.microproxy.FlowRecord) once it is over: an HTTP exchange once its response has been written (or it was abandoned), a CONNECT tunnel, a SOCKS client's tunnel, a WebSocket session, a tunnel seen by the TCP hooks, a CONNECT-UDP flow, and a QUIC flow the transparent QUIC listener relayed or intercepted stream by stream, each when it closes.
FlowRecord.Builder	Builds a FlowRecord; unset values are unknown.
FlowRecord.Kind	What kind of exchange or flow a record is about; %MP_FLOW% renders its FlowRecord.Kind.label().
FlowTimings	When the phases of one request/response exchange happened, from FlowContext.timings().
FlowTrace	The distributed trace of one exchange, made by a FlowTracer when the request head arrives: its trace and span ids, which FlowContext.trace(), access logs ( %TRACE_ID%, %SPAN_ID%) and scripts (ctx.trace_id) show, and the calls through which the proxy reports each attempt to reach the server and asks for the headers that carry the trace to it.
FlowTrace.Span	A span FlowTrace.startSpan(java.lang.String) started, used by one thread at a time.
FlowTracer	Traces the proxy's exchanges and flows: given with HttpProxyServerBootstrap.withTracer(org.microproxy.FlowTracer), it is asked for a FlowTrace when each request head arrives, and handed each exchange's and flow's FlowRecord when it is over.
FullFlowContext	A FlowContext that also knows the server side of the flow.
GeneratedResponses	How HttpFilters.proxyToClientResponse(org.microproxy.http.HttpObject) treats the responses the proxy answers with itself, rather than relaying a server's: its own error responses (the 502 for a server it cannot reach, the 504 for one that does not answer, a 400 for a bad request, the FailureResponder's and HttpFilters.proxyToServerFailure(org.microproxy.ProxyFailure)'s answers, ...), and the short-circuit responses a filter returned from an earlier hook (HttpFilters.clientToProxyRequest(org.microproxy.http.HttpObject), HttpFilters.proxyToServerRequest(org.microproxy.http.HttpObject)), the HttpCache's answers included.
HostResolver	Resolves server host names.
Http1PolicyBuilder	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 Http1PolicyBuilder.requestHeadTimeout(java.time.Duration) and Http1PolicyBuilder.allowChunkedLength(boolean).
Http2Options	Limits for HTTP/2 client connections (HttpProxyServerBootstrap.withHttp2(boolean)).
Http2Options.Builder	Builds Http2Options.
Http3Options	Limits and timers for HTTP/3 (HttpProxyServerBootstrap.withHttp3(boolean) and HttpProxyServerBootstrap.withHttp3Upstream(boolean)).
Http3Options.Builder	Builds Http3Options.
Http3Options.QuicCongestionControl	The congestion controllers of the proxy's QUIC connections (see Http3Options.Builder.quicCongestionControl).
HttpFilters	Hooks into the life of a single request/response exchange.
HttpFiltersBuilder	Builds HttpFilters from lambdas, one per hook, instead of a class that overrides the hooks it needs:
HttpFiltersBuilder.Body	The streams a built filter inspects piece by piece.
HttpFiltersBuilder.Built	Filters made by HttpFiltersBuilder.
HttpFiltersSource	Creates the HttpFilters for each request.
HttpProxyServer	A running proxy.
HttpProxyServerBootstrap	Configures and starts a HttpProxyServer.
KeyMaterial	A certificate chain and the private key of its first certificate: what a TLS server presents.
MitmManager	Enables man-in-the-middle interception of CONNECT tunnels.
MitmServerHandshake	When the proxy runs its TLS handshake with the server for a CONNECT it intercepts: after answering the CONNECT and reading the client's ClientHello, or before answering.
NoProxyRules	Hosts that bypass the upstream proxy, in the comma-separated NO_PROXY syntax used by curl and most HTTP clients: * matches every host; example.com, .example.com and *.example.com match the domain and all its subdomains; an IP literal matches that address, and CIDR notation (10.0.0.0/8, fd00::/8) matches a range; addresses are compared only when the request names an IP literal (no DNS lookups); any entry may end in :port to apply to that port only.
PoolMetrics	A snapshot of the shared server connection pool.
ProtocolPolicy	How the proxy behaves, where it can behave in more than one way, for the exchanges of clients that speak one protocol: HTTP/1.x, HTTP/2 or HTTP/3 (the protocol the client speaks to the proxy, FlowContext.getHttpVersion()).
ProtocolPolicy.Builder	Builds a ProtocolPolicy.
ProxyAuthenticator	Decides which clients may use the proxy.
ProxyFailure	Why the proxy has to answer a request itself instead of relaying the server's response.
ProxyFailure.TlsFailed.Reason	Why a TLS handshake failed, read from the exception's cause chain: the certificate checks first, then an alert from the peer, a timeout, or anything else.
ProxyProtocolDestination	Which address a PROXY protocol header the proxy sends to a server (HttpProxyServerBootstrap.withSendProxyProtocol(boolean)) names as its destination, when the client's connection did not bring a header of its own (whose destination is passed on as it is).
ProxyProtocolMode	Whether client connections start with a PROXY protocol header (v1 or v2, as HAProxy defines them), which names the client a load balancer in front of the proxy connected for.
ResponseFlag	Why an exchange or a flow ended the way it did, in the vocabulary of Envoy's access-log response flags: each constant has Envoy's short code (UF, UT, ...) and long name, so logs read by tools made for Envoy keep their meaning.
ResponseSource	Where a response sent to the client came from; see ActivityTracker.responseSentToClient(FlowContext, HttpResponse, ResponseSource).
RetryBackoff	How long the proxy waits before trying the next route after a connection attempt failed: the next chained proxy, or the direct fallback, that the ChainedProxyManager offered.
ReverseProxyMode	Reverse proxy mode: every request on the listener goes to one fixed upstream server, whatever its target, as a server of its own rather than a forward proxy.
ScriptCallObserver	Sees every call into a script's hooks (with the optional Starlark module): when it starts, and how it ended, with the interpreter steps it ran, about how many bytes of values it created, how long it took and why it failed.
ScriptUsage	What the calls into scripts for one exchange added up to, as FlowContext.scriptStats() gives it: how many calls, how long they took, how many interpreter steps they ran and about how many bytes of values they created (an estimate of what was made, not of what stayed in memory).
SelectiveFilters	Filters that say which streams they inspect piece by piece.
ServerConnectionPoolType	Implementations of the shared server connection pool.
ServerState	Where a proxy is in its life (HttpProxyServer.state()), with the names Envoy's admin /ready answers and the numbers its server.state gauge shows.
SslContextSource	Supplies TLS configuration for one side of a connection.
TlsServerIdentity	Who the proxy expects at the other end of a TLS connection to a server, when that is not simply the request's host: the server name it sends in the ClientHello (SNI, RFC 6066 section 3) and the host name the server's certificate is verified against (HTTPS endpoint identification, RFC 9110 section 4.3.4).
UpstreamProxyManager	A ChainedProxyManager configured like command-line HTTP clients: an upstream proxy URL for plain HTTP, one for HTTPS (CONNECT), and NoProxyRules for hosts reached directly.

Classes in org.microproxy used by org.microproxy.cache

Class	Description
FlowContext	Information about the client side of a proxied flow.
HttpFilters	Hooks into the life of a single request/response exchange.
HttpFiltersSource	Creates the HttpFilters for each request.

Classes in org.microproxy used by org.microproxy.dns

Class	Description
HostResolver	Resolves server host names.

Classes in org.microproxy used by org.microproxy.extras

Class	Description
ActivityTracker	Observes proxy activity, e.g. for metrics or access logs.
ActivityTrackerAdapter	An ActivityTracker that ignores everything; extend it and override what you need.
ClientHello	A client's TLS ClientHello, the first message of a handshake, as the proxy read it before deciding whether to intercept a connection: after a CONNECT is accepted, and first thing on a connection to a transparent listener.
FlowContext	Information about the client side of a proxied flow.
FlowRecord	What an access log needs to know about one finished exchange or flow, handed to ActivityTracker.flowEnded(org.microproxy.FlowRecord) once it is over: an HTTP exchange once its response has been written (or it was abandoned), a CONNECT tunnel, a SOCKS client's tunnel, a WebSocket session, a tunnel seen by the TCP hooks, a CONNECT-UDP flow, and a QUIC flow the transparent QUIC listener relayed or intercepted stream by stream, each when it closes.
HttpFilters	Hooks into the life of a single request/response exchange.
HttpFiltersSource	Creates the HttpFilters for each request.
ResponseFlag	Why an exchange or a flow ended the way it did, in the vocabulary of Envoy's access-log response flags: each constant has Envoy's short code (UF, UT, ...) and long name, so logs read by tools made for Envoy keep their meaning.
SelectiveFilters	Filters that say which streams they inspect piece by piece.

Classes in org.microproxy used by org.microproxy.frames

Class	Description
FlowContext	Information about the client side of a proxied flow.

Classes in org.microproxy used by org.microproxy.otel

Class	Description
ActivityTracker	Observes proxy activity, e.g. for metrics or access logs.
FlowContext	Information about the client side of a proxied flow.
FlowRecord	What an access log needs to know about one finished exchange or flow, handed to ActivityTracker.flowEnded(org.microproxy.FlowRecord) once it is over: an HTTP exchange once its response has been written (or it was abandoned), a CONNECT tunnel, a SOCKS client's tunnel, a WebSocket session, a tunnel seen by the TCP hooks, a CONNECT-UDP flow, and a QUIC flow the transparent QUIC listener relayed or intercepted stream by stream, each when it closes.
FlowTrace	The distributed trace of one exchange, made by a FlowTracer when the request head arrives: its trace and span ids, which FlowContext.trace(), access logs ( %TRACE_ID%, %SPAN_ID%) and scripts (ctx.trace_id) show, and the calls through which the proxy reports each attempt to reach the server and asks for the headers that carry the trace to it.
FlowTracer	Traces the proxy's exchanges and flows: given with HttpProxyServerBootstrap.withTracer(org.microproxy.FlowTracer), it is asked for a FlowTrace when each request head arrives, and handed each exchange's and flow's FlowRecord when it is over.
HttpProxyServer	A running proxy.
HttpProxyServerBootstrap	Configures and starts a HttpProxyServer.
LauncherExtension	Adds command-line options to Launcher.

Classes in org.microproxy used by org.microproxy.quic

Class	Description
FlowContext	Information about the client side of a proxied flow.

Classes in org.microproxy used by org.microproxy.starlark

Class	Description
AuthResult	What a ProxyAuthenticator decided about a request.
ChainedProxy	An upstream proxy that requests are forwarded through.
ChainedProxyManager	Chooses upstream proxies for each request.
ClientDetails	What the proxy knows about a client: its address and, once authenticated, its user name.
FlowContext	Information about the client side of a proxied flow.
HttpFilters	Hooks into the life of a single request/response exchange.
HttpFiltersSource	Creates the HttpFilters for each request.
HttpProxyServerBootstrap	Configures and starts a HttpProxyServer.
LauncherExtension	Adds command-line options to Launcher.
ProxyAuthenticator	Decides which clients may use the proxy.
ScriptCallObserver	Sees every call into a script's hooks (with the optional Starlark module): when it starts, and how it ended, with the interpreter steps it ran, about how many bytes of values it created, how long it took and why it failed.

Classes in org.microproxy used by org.microproxy.tcp

Class	Description
FlowContext	Information about the client side of a proxied flow.

Classes in org.microproxy used by org.microproxy.tls

Class	Description
KeyMaterial	A certificate chain and the private key of its first certificate: what a TLS server presents.
MitmManager	Enables man-in-the-middle interception of CONNECT tunnels.
SslContextSource	Supplies TLS configuration for one side of a connection.

Classes in org.microproxy used by org.microproxy.udp

Class	Description
FlowContext	Information about the client side of a proxied flow.

Classes in org.microproxy used by org.microproxy.warc

Class	Description
FlowContext	Information about the client side of a proxied flow.
HttpFilters	Hooks into the life of a single request/response exchange.
HttpFiltersSource	Creates the HttpFilters for each request.