Package org.microproxy

Interface ProxyFailure

All Known Implementing Classes:

ProxyFailure.BadRequest, ProxyFailure.BadServerResponse, ProxyFailure.ConnectFailed, ProxyFailure.NoConnectionAvailable, ProxyFailure.NoRoute, ProxyFailure.RequestTooLarge, ProxyFailure.ServerTimeout, ProxyFailure.TlsFailed, ProxyFailure.UnresolvedHost

public sealed interface ProxyFailure
permits ProxyFailure.UnresolvedHost, ProxyFailure.ConnectFailed, ProxyFailure.TlsFailed, ProxyFailure.ServerTimeout, ProxyFailure.BadServerResponse, ProxyFailure.NoRoute, ProxyFailure.NoConnectionAvailable, ProxyFailure.BadRequest, ProxyFailure.RequestTooLarge

Why the proxy has to answer a request itself instead of relaying the server's response. Each failure knows the status of the proxy's default answer; HttpFilters.proxyToServerFailure(org.microproxy.ProxyFailure) and a FailureResponder can answer differently.

The default answers are short plain-text bodies (Bad Gateway, Gateway Timeout, ...) that never echo the request. Requests the proxy cannot parse at all (malformed or oversized heads, bad chunk framing) are answered with a plain 4xx without consulting filters or the responder, since there is no request to hand over.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ProxyFailure.BadRequest	The proxy refuses the request: an origin-form request without HttpProxyServerBootstrap.withAllowRequestToOriginServer(boolean), an https:// request without HttpProxyServerBootstrap.withTlsOrigination(boolean), or a CONNECT target that is not host:port.
static final record	ProxyFailure.BadServerResponse	The server's response was malformed, or the server closed the connection or failed before the response head (or a body the filters asked to buffer) was complete.
static final record	ProxyFailure.ConnectFailed	No connection could be made to the server or any chained proxy offered for it: refused, unreachable, timed out, a chained proxy whose own name did not resolve, or a chained proxy that refused the CONNECT or SOCKS request.
static final record	ProxyFailure.NoConnectionAvailable	The shared connection pool had no connection to spare within the connect timeout.
static final record	ProxyFailure.NoRoute	There is nowhere to send the request: it names no host (hostAndPort is null), or the ChainedProxyManager offered no route.
static final record	ProxyFailure.RequestTooLarge	The request body is larger than the filters asked to buffer (maxBytes).
static final record	ProxyFailure.ServerTimeout	The server did not answer within the idle timeout.
static final record	ProxyFailure.TlsFailed	The TLS handshake with the server (when intercepting) or with a TLS chained proxy failed or did not finish within HttpProxyServerBootstrap.withTlsHandshakeTimeout(java.time.Duration) (or the request's HttpFilters.proxyToServerTlsHandshakeTimeout()), e.g. because its certificate is not trusted.
static final record	ProxyFailure.UnresolvedHost	The server's name did not resolve (direct connections).

Method Summary

Modifier and Type	Method	Description
HttpResponseStatus	status()	Returns the status of the proxy's default answer.

Method Details

status

HttpResponseStatus status()

Returns the status of the proxy's default answer.

Returns:

the status of the proxy's default answer