com.squareup.okhttp.internal.http

Class HttpURLConnectionImpl

java.lang.Object

java.net.URLConnection

java.net.HttpURLConnection

com.squareup.okhttp.internal.http.HttpURLConnectionImpl

All Implemented Interfaces:

Policy

public class HttpURLConnectionImpl
extends HttpURLConnection
implements Policy

This implementation uses HttpEngine to send requests and receive responses. This class may use multiple HttpEngines to follow redirects, authentication retries, etc. to retrieve the final response body.

What does 'connected' mean?

This class inherits a connected field from the superclass. That field is not used to indicate not 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. Test the connection field on this class for null/non-null to determine of an instance is currently connected to a server.

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpEngine	httpEngine
protected IOException	httpEngineFailure

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
HttpURLConnectionImpl(URL url, OkHttpClient client)

Method Summary

Modifier and Type	Method and Description
void	addRequestProperty(String field, String value)
void	connect()
void	disconnect()
int	getChunkLength()
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.
long	getFixedContentLength()
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()
HttpURLConnection	getHttpConnectionToCache() Returns the HttpURLConnection instance to store in the cache.
HttpEngine	getHttpEngine()
InputStream	getInputStream()
OutputStream	getOutputStream()
Permission	getPermission()
int	getReadTimeout()
Map<String,List<String>>	getRequestProperties()
String	getRequestProperty(String field)
int	getResponseCode()
String	getResponseMessage()
void	setConnectTimeout(int timeoutMillis)
void	setFixedLengthStreamingMode(int contentLength)
void	setFixedLengthStreamingMode(long contentLength)
void	setReadTimeout(int timeoutMillis)
void	setRequestProperty(String field, String newValue)
boolean	usingProxy() Returns true if a non-direct proxy is specified.

Methods inherited from class java.net.HttpURLConnection

getFollowRedirects, getHeaderFieldDate, getInstanceFollowRedirects, getRequestMethod, setChunkedStreamingMode, setFollowRedirects, setInstanceFollowRedirects, setRequestMethod

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, setIfModifiedSince, setUseCaches, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.squareup.okhttp.internal.http.Policy

getIfModifiedSince, getURL, getUseCaches

Field Detail

httpEngineFailure

protected IOException httpEngineFailure

httpEngine

protected HttpEngine httpEngine

Constructor Detail

HttpURLConnectionImpl

public HttpURLConnectionImpl(URL url,
                             OkHttpClient client)

Method Detail

connect

public final void connect()
                   throws IOException

Specified by:

connect in class URLConnection

Throws:

IOException

disconnect

public final void disconnect()

Specified by:

disconnect in class HttpURLConnection

getErrorStream

public final 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 final 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 final 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 final String getHeaderFieldKey(int position)

Overrides:

getHeaderFieldKey in class HttpURLConnection

getHeaderFields

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

Overrides:

getHeaderFields in class URLConnection

getRequestProperties

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

Overrides:

getRequestProperties in class URLConnection

getInputStream

public final InputStream getInputStream()
                                 throws IOException

Overrides:

getInputStream in class URLConnection

Throws:

IOException

getOutputStream

public final OutputStream getOutputStream()
                                   throws IOException

Overrides:

getOutputStream in class URLConnection

Throws:

IOException

getPermission

public final Permission getPermission()
                               throws IOException

Overrides:

getPermission in class HttpURLConnection

Throws:

IOException

getRequestProperty

public final String getRequestProperty(String field)

Overrides:

getRequestProperty in class URLConnection

setConnectTimeout

public void setConnectTimeout(int timeoutMillis)

Overrides:

setConnectTimeout in class URLConnection

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

getHttpConnectionToCache

public HttpURLConnection getHttpConnectionToCache()

Description copied from interface: Policy

Returns the HttpURLConnection instance to store in the cache.

Specified by:

getHttpConnectionToCache in interface Policy

getHttpEngine

public HttpEngine getHttpEngine()

getFixedContentLength

public final long getFixedContentLength()

Specified by:

getFixedContentLength in interface Policy

See Also:

HttpURLConnection.setFixedLengthStreamingMode(int)

getChunkLength

public final int getChunkLength()

Specified by:

getChunkLength in interface Policy

See Also:

HttpURLConnection.setChunkedStreamingMode(int)

usingProxy

public final boolean usingProxy()

Description copied from interface: Policy

Returns true if a non-direct proxy is specified.

Specified by:

usingProxy in interface Policy

Specified by:

usingProxy in class HttpURLConnection

getResponseMessage

public String getResponseMessage()
                          throws IOException

Overrides:

getResponseMessage in class HttpURLConnection

Throws:

IOException

getResponseCode

public final int getResponseCode()
                          throws IOException

Overrides:

getResponseCode in class HttpURLConnection

Throws:

IOException

setRequestProperty

public final void setRequestProperty(String field,
                                     String newValue)

Overrides:

setRequestProperty in class URLConnection

addRequestProperty

public final void addRequestProperty(String field,
                                     String value)

Overrides:

addRequestProperty in class URLConnection

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(int contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection

setFixedLengthStreamingMode

public void setFixedLengthStreamingMode(long contentLength)

Overrides:

setFixedLengthStreamingMode in class HttpURLConnection