Proxy.HttpConnectCallback

public abstract class Proxy.HttpConnectCallback

Controls tunnels established via HTTP CONNECT. All methods will be invoked onto the Executor specified in createHttpProxy.

Methods within this class are invoked only when both of the following are true: 

- HttpEngine must establish a connection to the destination of an HTTP request
- The destination of the HTTP request has an https URI scheme
 Refer to createHttpProxy's documentation to understand how CronetEngine decides whether to establish a tunnel through an HTTP proxy.

Summary

Nested types

Actions that can be performed in response to onResponseReceived being called.
public abstract class Proxy.HttpConnectCallback.Request implements AutoCloseable

Represents an HTTP CONNECT request being sent to the proxy server.

Constants
static final int

Closes the tunnel connection, preventing it from being used to send HTTP requests.
static final int

Proceeds establishing a tunnel.

Public constructors

Public methods
abstract void

Called before sending an HTTP CONNECT request to the proxy to establish a tunnel.
abstract int

Called after receiving a response to the HTTP CONNECT request sent to the proxy to establish a tunnel.

Constants

RESPONSE_ACTION_CLOSE

public static final int RESPONSE_ACTION_CLOSE = 0

Closes the tunnel connection, preventing it from being used to send HTTP requests.

When a tunnel connection is closed, CronetEngine will interpret it as a failure to use the associated Proxy. CronetEngine will then try the next Proxy in the list passed to ProxyOptions (refer to that class documentation for more info).

RESPONSE_ACTION_PROCEED

public static final int RESPONSE_ACTION_PROCEED = 1

Proceeds establishing a tunnel.

This does not guarantee that the tunnel will successfully be established and used to send HTTP requests: CronetEngine will perform additional checks prior to that. Depending on their outcome, CronetEngine might still decide to close the tunnel connection. If the tunnel connection ends up being closed by CronetEngine, it will be considered as a failure to use the associated Proxy. CronetEngine will then try the next Proxy in the list passed to ProxyOptions (refer to that class documentation for more info)

Public constructors

HttpConnectCallback

public HttpConnectCallback()

Public methods

onBeforeRequest

public abstract void onBeforeRequest(@NonNull Proxy.HttpConnectCallback.Request request)

Called before sending an HTTP CONNECT request to the proxy to establish a tunnel.

Allows manipulating, or canceling, said request before sending it to the proxy. Refer to Request to learn how a request can be manipulated/canceled.

Parameters
@NonNull Proxy.HttpConnectCallback.Request request

Represents the HTTP CONNECT request that will be sent to the proxy.

onResponseReceived

@Proxy.HttpConnectCallback.OnResponseReceivedAction
public abstract int onResponseReceived(
    @NonNull List<Pair<String, String>> responseHeaders,
    int statusCode
)

Called after receiving a response to the HTTP CONNECT request sent to the proxy to establish a tunnel. Allows reading headers and status code.

When sending HTTP requests to a destination with an https URI schene, CronetEngine will never use a proxy whose onResponseReceived callback has not been invoked.

This will not be called for HTTP requests that will go through the tunnel once it is established.

If this method throws any java.lang.Throwable, the fate of the tunnel will be as if RESPONSE_ACTION_CLOSE had been returned (the java.lang.Throwable will not be caught).

Parameters
@NonNull List<Pair<String, String>> responseHeaders

The list of headers contained in the response to the HTTP CONNECT request.
int statusCode

The HTTP status code contained in the response to the HTTP CONNECT request.
Returns
int

A OnResponseReceivedAction value representing what should be done with this tunnel connection. Refer to OnResponseReceivedAction documentation.