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 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESPONSE_SOURCE Synthetic response header: the location from which the response was loaded.
static String	SELECTED_PROTOCOL Synthetic response header: the selected protocol ("spdy/3.1", "http/1.1", etc).

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(URL url, OkHttpClient client)
OkHttpURLConnection(URL url, OkHttpClient client, URLFilter urlFilter)

Method Summary

Modifier and Type	Method and Description
void	addRequestProperty(String field, String value)
void	connect()
void	disconnect()
int	getConnectTimeout()
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.
String	getHeaderField(int position) Returns the value of the field at position.
String	getHeaderField(String fieldName) Returns the value of the field corresponding to the fieldName, or null if there is no such field.
String	getHeaderFieldKey(int position)
Map<String,List<String>>	getHeaderFields()
InputStream	getInputStream()
boolean	getInstanceFollowRedirects()
OutputStream	getOutputStream()
Permission	getPermission()
int	getReadTimeout()
Map<String,List<String>>	getRequestProperties()
String	getRequestProperty(String field)
int	getResponseCode()
String	getResponseMessage()
void	onFailure(Call call, 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.
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(String method)
void	setRequestProperty(String field, String newValue)
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 String SELECTED_PROTOCOL

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

RESPONSE_SOURCE

public static final String RESPONSE_SOURCE

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

Constructor Detail

OkHttpURLConnection

public OkHttpURLConnection(URL url,
                           OkHttpClient client)

OkHttpURLConnection

public OkHttpURLConnection(URL url,
                           OkHttpClient client,
                           URLFilter urlFilter)

Method Detail

connect

public void connect()
             throws IOException

Specified by:

connect in class URLConnection

Throws:

IOException

disconnect

public void disconnect()

Specified by:

disconnect in class HttpURLConnection

getErrorStream

public 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 HttpURLConnection

getHeaderField

public 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 HttpURLConnection

getHeaderField

public String getHeaderField(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 URLConnection

getHeaderFieldKey

public String getHeaderFieldKey(int position)

Overrides:

getHeaderFieldKey in class HttpURLConnection

getHeaderFields

public Map<String,List<String>> getHeaderFields()

Overrides:

getHeaderFields in class URLConnection

getRequestProperties

public Map<String,List<String>> getRequestProperties()

Overrides:

getRequestProperties in class URLConnection

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class URLConnection

Throws:

IOException

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class URLConnection

Throws:

IOException

getPermission

public Permission getPermission()
                         throws IOException

Overrides:

getPermission in class HttpURLConnection

Throws:

IOException

getRequestProperty

public String getRequestProperty(String field)

Overrides:

getRequestProperty in class URLConnection

setConnectTimeout

public void setConnectTimeout(int timeoutMillis)

Overrides:

setConnectTimeout in class URLConnection

setInstanceFollowRedirects

public void setInstanceFollowRedirects(boolean followRedirects)

Overrides:

setInstanceFollowRedirects in class HttpURLConnection

getInstanceFollowRedirects

public boolean getInstanceFollowRedirects()

Overrides:

getInstanceFollowRedirects in class HttpURLConnection

getConnectTimeout

public int getConnectTimeout()

Overrides:

getConnectTimeout in class URLConnection

setReadTimeout

public void setReadTimeout(int timeoutMillis)

Overrides:

setReadTimeout in class URLConnection

getReadTimeout

public int getReadTimeout()

Overrides:

getReadTimeout in class URLConnection

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 HttpURLConnection

getResponseMessage

public String getResponseMessage()
                          throws IOException

Overrides:

getResponseMessage in class HttpURLConnection

Throws:

IOException

getResponseCode

public int getResponseCode()
                    throws IOException

Overrides:

getResponseCode in class HttpURLConnection

Throws:

IOException

setRequestProperty

public void setRequestProperty(String field,
                               String newValue)

Overrides:

setRequestProperty in class URLConnection

setIfModifiedSince

public void setIfModifiedSince(long newValue)

Overrides:

setIfModifiedSince in class URLConnection

addRequestProperty

public void addRequestProperty(String field,
                               String value)

Overrides:

addRequestProperty in class URLConnection

setRequestMethod

public void setRequestMethod(String method)
                      throws ProtocolException

Overrides:

setRequestMethod in class HttpURLConnection

Throws:

ProtocolException

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(int contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(long contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection

onFailure

public void onFailure(Call call,
                      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