Proxy.HttpConnectCallback

public static interface Proxy.HttpConnectCallback

android.net.http.Proxy.HttpConnectCallback

Controls tunnels established via HTTP CONNECT. All methods will be invoked onto the Executor specified in Proxy.createHttpProxy(int, String, int, Executor, HttpConnectCallback).

Methods within this class are invoked only when HttpEngine must establish a tunnel through the proxy. Refer to Proxy.createHttpProxy(int, String, int, Executor, HttpConnectCallback)'s documentation to understand when that is the case.

Summary

Nested classes

class Proxy.HttpConnectCallback.Request

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

Constants

int RESPONSE_ACTION_CLOSE

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

int RESPONSE_ACTION_PROCEED

Proceeds establishing a tunnel.

Public methods

abstract void onBeforeRequest(Proxy.HttpConnectCallback.Request request)

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

abstract int onResponseReceived(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.

Constants

RESPONSE_ACTION_CLOSE

public static final int RESPONSE_ACTION_CLOSE

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

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

Constant Value: 0 (0x00000000)

RESPONSE_ACTION_PROCEED

public static final int RESPONSE_ACTION_PROCEED

Proceeds establishing a tunnel.

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

Constant Value: 1 (0x00000001)

Public methods

onBeforeRequest

public abstract void onBeforeRequest (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
request Proxy.HttpConnectCallback.Request: Represents the HTTP CONNECT request that will be sent to the proxy.
This value cannot be null.

onResponseReceived

public abstract int onResponseReceived (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.

This method must return before any HTTP request can be sent via the tunnel that is being established.

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

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

Parameters
responseHeaders List: The list of headers contained in the response to the HTTP CONNECT request.
This value cannot be null.
statusCode int: The HTTP status code contained in the response to the HTTP CONNECT request.
Returns
int A ERROR(OnResponseReceivedAction/android.net.http.Proxy.HttpConnectCallback.OnResponseReceivedAction OnResponseReceivedAction) value representing what should be done with this tunnel connection. Refer to ERROR(OnResponseReceivedAction/android.net.http.Proxy.HttpConnectCallback.OnResponseReceivedAction OnResponseReceivedAction) documentation.
Value is one of the following: