okhttp3.internal.huc

Class OkHttpURLConnection

java.lang.Object

java.net.URLConnection

java.net.HttpURLConnection

okhttp3.internal.huc.OkHttpURLConnection

All Implemented Interfaces:

Callback

public final class OkHttpURLConnection
extends java.net.HttpURLConnection
implements Callback

This implementation uses Call to send requests and receive responses.

What does 'connected' mean?

This class inherits a connected field from the superclass. That field is not used to indicate whether this URLConnection is currently connected. Instead, it indicates whether a connection has ever been attempted. Once a connection has been attempted, certain properties (request header fields, request method, etc.) are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	OkHttpURLConnection.NetworkInterceptor The HttpURLConnection gives the application control between establishing the connection and transmitting the request body.
(package private) static class	OkHttpURLConnection.UnexpectedException

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Call	call
private java.lang.Throwable	callFailure
(package private) OkHttpClient	client
(package private) boolean	connectPending
private boolean	executed
private long	fixedContentLength Like the superclass field of the same name, but a long and available on all platforms.
(package private) Handshake	handshake
private java.lang.Object	lock
private static java.util.Set<java.lang.String>	METHODS
private OkHttpURLConnection.NetworkInterceptor	networkInterceptor
(package private) Response	networkResponse
(package private) java.net.Proxy	proxy
private Headers.Builder	requestHeaders
private Response	response
static java.lang.String	RESPONSE_SOURCE Synthetic response header: the location from which the response was loaded.
private Headers	responseHeaders Lazily created (with synthetic headers) on first call to getHeaders().
static java.lang.String	SELECTED_PROTOCOL Synthetic response header: the selected protocol ("spdy/3.1", "http/1.1", etc).
(package private) URLFilter	urlFilter

Fields inherited from class java.net.HttpURLConnection

chunkLength, fixedContentLengthLong, HTTP_ACCEPTED, HTTP_BAD_GATEWAY, HTTP_BAD_METHOD, HTTP_BAD_REQUEST, HTTP_CLIENT_TIMEOUT, HTTP_CONFLICT, HTTP_CREATED, HTTP_ENTITY_TOO_LARGE, HTTP_FORBIDDEN, HTTP_GATEWAY_TIMEOUT, HTTP_GONE, HTTP_INTERNAL_ERROR, HTTP_LENGTH_REQUIRED, HTTP_MOVED_PERM, HTTP_MOVED_TEMP, HTTP_MULT_CHOICE, HTTP_NO_CONTENT, HTTP_NOT_ACCEPTABLE, HTTP_NOT_AUTHORITATIVE, HTTP_NOT_FOUND, HTTP_NOT_IMPLEMENTED, HTTP_NOT_MODIFIED, HTTP_OK, HTTP_PARTIAL, HTTP_PAYMENT_REQUIRED, HTTP_PRECON_FAILED, HTTP_PROXY_AUTH, HTTP_REQ_TOO_LONG, HTTP_RESET, HTTP_SEE_OTHER, HTTP_SERVER_ERROR, HTTP_UNAUTHORIZED, HTTP_UNAVAILABLE, HTTP_UNSUPPORTED_TYPE, HTTP_USE_PROXY, HTTP_VERSION, instanceFollowRedirects, method, responseCode, responseMessage

Fields inherited from class java.net.URLConnection

allowUserInteraction, connected, doInput, doOutput, ifModifiedSince, url, useCaches

Constructor Summary

Constructors

Constructor and Description
OkHttpURLConnection(java.net.URL url, OkHttpClient client)
OkHttpURLConnection(java.net.URL url, OkHttpClient client, URLFilter urlFilter)

Method Summary

Modifier and Type	Method and Description
void	addRequestProperty(java.lang.String field, java.lang.String value)
private Call	buildCall()
void	connect()
private java.lang.String	defaultUserAgent()
void	disconnect()
int	getConnectTimeout()
java.io.InputStream	getErrorStream() Returns an input stream from the server in the case of error such as the requested file (txt, htm, html) is not found on the remote server.
java.lang.String	getHeaderField(int position) Returns the value of the field at position.
java.lang.String	getHeaderField(java.lang.String fieldName) Returns the value of the field corresponding to the fieldName, or null if there is no such field.
java.lang.String	getHeaderFieldKey(int position)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaderFields()
private Headers	getHeaders()
java.io.InputStream	getInputStream()
boolean	getInstanceFollowRedirects()
java.io.OutputStream	getOutputStream()
java.security.Permission	getPermission()
int	getReadTimeout()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestProperties()
java.lang.String	getRequestProperty(java.lang.String field)
private Response	getResponse(boolean networkResponseOnError) Aggressively tries to get the final HTTP response, potentially making many HTTP requests in the process in order to cope with redirects and authentication.
int	getResponseCode()
java.lang.String	getResponseMessage()
void	onFailure(Call call, java.io.IOException e) Called when the request could not be executed due to cancellation, a connectivity problem or timeout.
void	onResponse(Call call, Response response) Called when the HTTP response was successfully returned by the remote server.
private static java.io.IOException	propagate(java.lang.Throwable throwable) Throws throwable as either an IOException, RuntimeException, or Error.
private static java.lang.String	responseSourceHeader(Response response)
void	setConnectTimeout(int timeoutMillis)
void	setFixedLengthStreamingMode(int contentLength)
void	setFixedLengthStreamingMode(long contentLength)
void	setIfModifiedSince(long newValue)
void	setInstanceFollowRedirects(boolean followRedirects)
void	setReadTimeout(int timeoutMillis)
void	setRequestMethod(java.lang.String method)
void	setRequestProperty(java.lang.String field, java.lang.String newValue)
private static java.lang.String	toHumanReadableAscii(java.lang.String s) Returns s with control characters and non-ASCII characters replaced with '?'.
boolean	usingProxy() Returns true if either: A specific proxy was explicitly configured for this connection.

Methods inherited from class java.net.HttpURLConnection

getFollowRedirects, getHeaderFieldDate, getRequestMethod, setChunkedStreamingMode, setFollowRedirects

Methods inherited from class java.net.URLConnection

getAllowUserInteraction, getContent, getContent, getContentEncoding, getContentLength, getContentLengthLong, getContentType, getDate, getDefaultAllowUserInteraction, getDefaultRequestProperty, getDefaultUseCaches, getDoInput, getDoOutput, getExpiration, getFileNameMap, getHeaderFieldInt, getHeaderFieldLong, getIfModifiedSince, getLastModified, getURL, getUseCaches, guessContentTypeFromName, guessContentTypeFromStream, setAllowUserInteraction, setContentHandlerFactory, setDefaultAllowUserInteraction, setDefaultRequestProperty, setDefaultUseCaches, setDoInput, setDoOutput, setFileNameMap, setUseCaches, toString

Methods inherited from class java.lang.Object

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

Field Detail

SELECTED_PROTOCOL

public static final java.lang.String SELECTED_PROTOCOL

Synthetic response header: the selected protocol ("spdy/3.1", "http/1.1", etc).

RESPONSE_SOURCE

public static final java.lang.String RESPONSE_SOURCE

Synthetic response header: the location from which the response was loaded.

METHODS

private static final java.util.Set<java.lang.String> METHODS

client

OkHttpClient client

networkInterceptor

private final OkHttpURLConnection.NetworkInterceptor networkInterceptor

requestHeaders

private Headers.Builder requestHeaders

executed

private boolean executed

call

Call call

urlFilter

URLFilter urlFilter

responseHeaders

private Headers responseHeaders

Lazily created (with synthetic headers) on first call to getHeaders().

fixedContentLength

private long fixedContentLength

Like the superclass field of the same name, but a long and available on all platforms.

lock

private final java.lang.Object lock

response

private Response response

callFailure

private java.lang.Throwable callFailure

networkResponse

Response networkResponse

connectPending

boolean connectPending

proxy

java.net.Proxy proxy

handshake

Handshake handshake

Constructor Detail

OkHttpURLConnection

public OkHttpURLConnection(java.net.URL url,
                           OkHttpClient client)

OkHttpURLConnection

public OkHttpURLConnection(java.net.URL url,
                           OkHttpClient client,
                           URLFilter urlFilter)

Method Detail

connect

public void connect()
             throws java.io.IOException

Specified by:

connect in class java.net.URLConnection

Throws:

java.io.IOException

disconnect

public void disconnect()

Specified by:

disconnect in class java.net.HttpURLConnection

getErrorStream

public java.io.InputStream getErrorStream()

Returns an input stream from the server in the case of error such as the requested file (txt, htm, html) is not found on the remote server.

Overrides:

getErrorStream in class java.net.HttpURLConnection

getHeaders

private Headers getHeaders()
                    throws java.io.IOException

Throws:

java.io.IOException

responseSourceHeader

private static java.lang.String responseSourceHeader(Response response)

getHeaderField

public java.lang.String getHeaderField(int position)

Returns the value of the field at position. Returns null if there are fewer than position headers.

Overrides:

getHeaderField in class java.net.HttpURLConnection

getHeaderField

public java.lang.String getHeaderField(java.lang.String fieldName)

Returns the value of the field corresponding to the fieldName, or null if there is no such field. If the field has multiple values, the last value is returned.

Overrides:

getHeaderField in class java.net.URLConnection

getHeaderFieldKey

public java.lang.String getHeaderFieldKey(int position)

Overrides:

getHeaderFieldKey in class java.net.HttpURLConnection

getHeaderFields

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaderFields()

Overrides:

getHeaderFields in class java.net.URLConnection

getRequestProperties

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestProperties()

Overrides:

getRequestProperties in class java.net.URLConnection

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Overrides:

getInputStream in class java.net.URLConnection

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Overrides:

getOutputStream in class java.net.URLConnection

Throws:

java.io.IOException

getPermission

public java.security.Permission getPermission()
                                       throws java.io.IOException

Overrides:

getPermission in class java.net.HttpURLConnection

Throws:

java.io.IOException

getRequestProperty

public java.lang.String getRequestProperty(java.lang.String field)

Overrides:

getRequestProperty in class java.net.URLConnection

setConnectTimeout

public void setConnectTimeout(int timeoutMillis)

Overrides:

setConnectTimeout in class java.net.URLConnection

setInstanceFollowRedirects

public void setInstanceFollowRedirects(boolean followRedirects)

Overrides:

setInstanceFollowRedirects in class java.net.HttpURLConnection

getInstanceFollowRedirects

public boolean getInstanceFollowRedirects()

Overrides:

getInstanceFollowRedirects in class java.net.HttpURLConnection

getConnectTimeout

public int getConnectTimeout()

Overrides:

getConnectTimeout in class java.net.URLConnection

setReadTimeout

public void setReadTimeout(int timeoutMillis)

Overrides:

setReadTimeout in class java.net.URLConnection

getReadTimeout

public int getReadTimeout()

Overrides:

getReadTimeout in class java.net.URLConnection

buildCall

private Call buildCall()
                throws java.io.IOException

Throws:

java.io.IOException

defaultUserAgent

private java.lang.String defaultUserAgent()

toHumanReadableAscii

private static java.lang.String toHumanReadableAscii(java.lang.String s)

Returns s with control characters and non-ASCII characters replaced with '?'.

getResponse

private Response getResponse(boolean networkResponseOnError)
                      throws java.io.IOException

Aggressively tries to get the final HTTP response, potentially making many HTTP requests in the process in order to cope with redirects and authentication.

Throws:

java.io.IOException

usingProxy

public boolean usingProxy()

Returns true if either:

• A specific proxy was explicitly configured for this connection.
• The response has already been retrieved, and a proxy was selected in order to get it.

Warning: This method may return false before attempting to connect and true afterwards.

Specified by:

usingProxy in class java.net.HttpURLConnection

getResponseMessage

public java.lang.String getResponseMessage()
                                    throws java.io.IOException

Overrides:

getResponseMessage in class java.net.HttpURLConnection

Throws:

java.io.IOException

getResponseCode

public int getResponseCode()
                    throws java.io.IOException

Overrides:

getResponseCode in class java.net.HttpURLConnection

Throws:

java.io.IOException

setRequestProperty

public void setRequestProperty(java.lang.String field,
                               java.lang.String newValue)

Overrides:

setRequestProperty in class java.net.URLConnection

setIfModifiedSince

public void setIfModifiedSince(long newValue)

Overrides:

setIfModifiedSince in class java.net.URLConnection

addRequestProperty

public void addRequestProperty(java.lang.String field,
                               java.lang.String value)

Overrides:

addRequestProperty in class java.net.URLConnection

setRequestMethod

public void setRequestMethod(java.lang.String method)
                      throws java.net.ProtocolException

Overrides:

setRequestMethod in class java.net.HttpURLConnection

Throws:

java.net.ProtocolException

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(int contentLength)

Overrides:

setFixedLengthStreamingMode in class java.net.HttpURLConnection

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(long contentLength)

Overrides:

setFixedLengthStreamingMode in class java.net.HttpURLConnection

onFailure

public void onFailure(Call call,
                      java.io.IOException e)

Description copied from interface: Callback

Called when the request could not be executed due to cancellation, a connectivity problem or timeout. Because networks can fail during an exchange, it is possible that the remote server accepted the request before the failure.

Specified by:

onFailure in interface Callback

onResponse

public void onResponse(Call call,
                       Response response)

Description copied from interface: Callback

Called when the HTTP response was successfully returned by the remote server. The callback may proceed to read the response body with Response.body. The response is still live until its response body is closed. The recipient of the callback may consume the response body on another thread.

Note that transport-layer success (receiving a HTTP response code, headers and body) does not necessarily indicate application-layer success: response may still indicate an unhappy HTTP response code like 404 or 500.

Specified by:

onResponse in interface Callback

propagate

private static java.io.IOException propagate(java.lang.Throwable throwable)
                                      throws java.io.IOException

Throws throwable as either an IOException, RuntimeException, or Error.

Throws:

java.io.IOException