Index (OkHttp 1.6.0 API)

A B C D E F G H I L M N O P R S T U V

A

Address - Class in com.squareup.okhttp: A specification for a connection to an origin server.
Address(String, int, SSLSocketFactory, HostnameVerifier, OkAuthenticator, Proxy, List<Protocol>) - Constructor for class com.squareup.okhttp.Address
authenticate(Proxy, URL, List<OkAuthenticator.Challenge>) - Method in interface com.squareup.okhttp.OkAuthenticator: Deprecated.

Returns a credential that satisfies the authentication challenge made by url.
authenticateProxy(Proxy, URL, List<OkAuthenticator.Challenge>) - Method in interface com.squareup.okhttp.OkAuthenticator: Deprecated.

Returns a credential that satisfies the authentication challenge made by proxy.

B

basic(String, String) - Static method in class com.squareup.okhttp.OkAuthenticator.Credential: Deprecated.

Returns an auth credential for the Basic scheme.

C

Cache - Class in com.squareup.okhttp: Caches HTTP and HTTPS responses to the filesystem so they may be reused, saving time and bandwidth.
Cache(File, long) - Constructor for class com.squareup.okhttp.Cache
CacheControl - Class in com.squareup.okhttp: A Cache-Control header with cache directives from a server or client.
charset() - Method in class com.squareup.okhttp.MediaType: Returns the charset of this media type, or null if this media type doesn't specify a charset.
charset(Charset) - Method in class com.squareup.okhttp.MediaType: Returns the charset of this media type, or defaultValue if this media type doesn't specify a charset.
cipherSuite() - Method in class com.squareup.okhttp.Handshake: Returns a cipher suite name like "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA".
clearOwner() - Method in class com.squareup.okhttp.Connection: Attempts to clears the owner of this connection.
clone() - Method in class com.squareup.okhttp.OkHttpClient: Returns a shallow copy of this OkHttpClient.
close() - Method in class com.squareup.okhttp.Cache
close() - Method in class com.squareup.okhttp.Connection
closeIfOwnedBy(Object) - Method in class com.squareup.okhttp.Connection: Closes this connection if it is currently owned by owner.
com.squareup.okhttp - package com.squareup.okhttp
connect(int, int, TunnelRequest) - Method in class com.squareup.okhttp.Connection
connected(Route) - Method in class com.squareup.okhttp.RouteDatabase: Deprecated.

Records success connecting to failedRoute.
Connection - Class in com.squareup.okhttp: The sockets and streams of an HTTP, HTTPS, or HTTPS+SPDY connection.
Connection(ConnectionPool, Route) - Constructor for class com.squareup.okhttp.Connection
ConnectionPool - Class in com.squareup.okhttp: Manages reuse of HTTP and SPDY connections for reduced network latency.
ConnectionPool(int, long) - Constructor for class com.squareup.okhttp.ConnectionPool
createURLStreamHandler(String) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
moved to OkUrlFactory.createURLStreamHandler.

D

delete() - Method in class com.squareup.okhttp.Cache: Closes the cache and deletes all of its stored values.

E

equals(Object) - Method in class com.squareup.okhttp.Address
equals(Object) - Method in class com.squareup.okhttp.Handshake
equals(Object) - Method in class com.squareup.okhttp.MediaType
equals(Object) - Method in class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.
equals(Object) - Method in class com.squareup.okhttp.OkAuthenticator.Credential: Deprecated.
equals(Object) - Method in class com.squareup.okhttp.Route
evictAll() - Method in class com.squareup.okhttp.ConnectionPool: Close and remove all connections in the pool.

F

failed(Route) - Method in class com.squareup.okhttp.RouteDatabase: Deprecated.

Records a failure connecting to failedRoute.
failedRoutesCount() - Method in class com.squareup.okhttp.RouteDatabase: Deprecated.
flush() - Method in class com.squareup.okhttp.Cache

G

get(URI, String, Map<String, List<String>>) - Method in class com.squareup.okhttp.Cache
get(Request) - Method in class com.squareup.okhttp.Cache
get(Address) - Method in class com.squareup.okhttp.ConnectionPool: Returns a recycled connection to address, or null if no such connection exists.
get(SSLSession) - Static method in class com.squareup.okhttp.Handshake
get(String, List<Certificate>, List<Certificate>) - Static method in class com.squareup.okhttp.Handshake
get(Request) - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.
getAddress() - Method in class com.squareup.okhttp.Route: Returns the Address of this route.
getAuthenticator() - Method in class com.squareup.okhttp.Address: Returns the client's authenticator.
getAuthenticator() - Method in class com.squareup.okhttp.OkHttpClient
getCache() - Method in class com.squareup.okhttp.OkHttpClient
getConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool: Returns total number of connections in the pool.
getConnectionPool() - Method in class com.squareup.okhttp.OkHttpClient
getConnectTimeout() - Method in class com.squareup.okhttp.OkHttpClient: Default connect timeout (in milliseconds).
getCookieHandler() - Method in class com.squareup.okhttp.OkHttpClient
getDefault() - Static method in class com.squareup.okhttp.ConnectionPool
getDirectory() - Method in class com.squareup.okhttp.Cache
getFollowProtocolRedirects() - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
moved to OkHttpClient.getFollowSslRedirects().
getFollowSslRedirects() - Method in class com.squareup.okhttp.OkHttpClient
getHandshake() - Method in class com.squareup.okhttp.Connection
getHeaderValue() - Method in class com.squareup.okhttp.OkAuthenticator.Credential: Deprecated.
getHitCount() - Method in class com.squareup.okhttp.Cache
getHostnameVerifier() - Method in class com.squareup.okhttp.Address: Returns the hostname verifier, or null if this is not an HTTPS address.
getHostnameVerifier() - Method in class com.squareup.okhttp.OkHttpClient
getHttpConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool: Returns total number of http connections in the pool.
getHttpMinorVersion() - Method in class com.squareup.okhttp.Connection: Returns the minor HTTP version that should be used for future requests on this connection.
getIdleStartTimeNs() - Method in class com.squareup.okhttp.Connection: Returns the time in ns when this connection became idle.
getMaxSize() - Method in class com.squareup.okhttp.Cache
getNetworkCount() - Method in class com.squareup.okhttp.Cache
getOkResponseCache() - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
replaced by OkHttpClient.getCache() which doesn't support custom cache implementations.
getOwner() - Method in class com.squareup.okhttp.Connection
getProtocols() - Method in class com.squareup.okhttp.Address: Returns the protocols the client supports.
getProtocols() - Method in class com.squareup.okhttp.OkHttpClient
getProxy() - Method in class com.squareup.okhttp.Address: Returns this address's explicitly-specified HTTP proxy, or null to delegate to the HTTP client's proxy selector.
getProxy() - Method in class com.squareup.okhttp.OkHttpClient
getProxy() - Method in class com.squareup.okhttp.Route: Returns the Proxy of this route.
getProxySelector() - Method in class com.squareup.okhttp.OkHttpClient
getReadTimeout() - Method in class com.squareup.okhttp.OkHttpClient: Default read timeout (in milliseconds).
getRealm() - Method in class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.

Returns the protection space.
getRequestCount() - Method in class com.squareup.okhttp.Cache
getResponseCache() - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
replaced by OkHttpClient.getCache() which doesn't support custom cache implementations.
getRoute() - Method in class com.squareup.okhttp.Connection: Returns the route used by this connection.
getRoutesDatabase() - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
removed from the public API in OkHttp 2.0.
getScheme() - Method in class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.

Returns the authentication scheme, like Basic.
getSize() - Method in class com.squareup.okhttp.Cache
getSocket() - Method in class com.squareup.okhttp.Connection: Returns the socket that this connection uses, or null if the connection is not currently connected.
getSocketAddress() - Method in class com.squareup.okhttp.Route: Returns the InetSocketAddress of this route.
getSpdyConnectionCount() - Method in class com.squareup.okhttp.ConnectionPool: Returns total number of spdy connections in the pool.
getSslSocketFactory() - Method in class com.squareup.okhttp.Address: Returns the SSL socket factory, or null if this is not an HTTPS address.
getSslSocketFactory() - Method in class com.squareup.okhttp.OkHttpClient
getTlsVersion() - Method in class com.squareup.okhttp.Route
getTransports() - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
OkHttp 1.5 enforces an enumeration of protocols that can be selected. Please switch to OkHttpClient.getProtocols().
getUriHost() - Method in class com.squareup.okhttp.Address: Returns the hostname of the origin server.
getUriPort() - Method in class com.squareup.okhttp.Address: Returns the port of the origin server; typically 80 or 443.
getWriteAbortCount() - Method in class com.squareup.okhttp.Cache
getWriteSuccessCount() - Method in class com.squareup.okhttp.Cache

H

Handshake - Class in com.squareup.okhttp: A record of a TLS handshake.
hashCode() - Method in class com.squareup.okhttp.Address
hashCode() - Method in class com.squareup.okhttp.Handshake
hashCode() - Method in class com.squareup.okhttp.MediaType
hashCode() - Method in class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.
hashCode() - Method in class com.squareup.okhttp.OkAuthenticator.Credential: Deprecated.
hashCode() - Method in class com.squareup.okhttp.Route
HttpResponseCache - Class in com.squareup.okhttp: Deprecated.
renamed to Cache.
HttpResponseCache(File, long) - Constructor for class com.squareup.okhttp.HttpResponseCache: Deprecated.

I

incrementRecycleCount() - Method in class com.squareup.okhttp.Connection
isAlive() - Method in class com.squareup.okhttp.Connection: Returns true if this connection is alive.
isClosed() - Method in class com.squareup.okhttp.Cache
isConnected() - Method in class com.squareup.okhttp.Connection: Returns true if Connection.connect(int, int, com.squareup.okhttp.TunnelRequest) has been attempted on this connection.
isExpired(long) - Method in class com.squareup.okhttp.Connection: Returns true if this connection has been idle for longer than keepAliveDurationNs.
isIdle() - Method in class com.squareup.okhttp.Connection: Returns true if this connection is idle.
isModernTls() - Method in class com.squareup.okhttp.Route: Deprecated.
replaced with Route.getTlsVersion() in OkHttp 2.0.
isPublic() - Method in class com.squareup.okhttp.CacheControl
isReadable() - Method in class com.squareup.okhttp.Connection: Returns true if we are confident that we can read data from this connection.
isSpdy() - Method in class com.squareup.okhttp.Connection: Returns true if this is a SPDY connection.

L

localCertificates() - Method in class com.squareup.okhttp.Handshake: Returns a possibly-empty list of certificates that identify this peer.
localPrincipal() - Method in class com.squareup.okhttp.Handshake: Returns the local principle, or null if this peer is anonymous.

M

maxAgeSeconds() - Method in class com.squareup.okhttp.CacheControl: The duration past the response's served date that it can be served without validation.
maxStaleSeconds() - Method in class com.squareup.okhttp.CacheControl
maybeRemove(Request) - Method in class com.squareup.okhttp.Cache
maybeRemove(Request) - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.

Remove any cache entries for the supplied uri.
MediaType - Class in com.squareup.okhttp: An RFC 2045 Media Type, appropriate to describe the content type of an HTTP request or response body.
minFreshSeconds() - Method in class com.squareup.okhttp.CacheControl
mustRevalidate() - Method in class com.squareup.okhttp.CacheControl

N

name - Variable in enum com.squareup.okhttp.Protocol: Deprecated.
removed from the public API in OkHttp 2.0.
newTransport(HttpEngine) - Method in class com.squareup.okhttp.Connection: Returns the transport appropriate for this connection.
noCache() - Method in class com.squareup.okhttp.CacheControl: In a response, this field's name "no-cache" is misleading.
noStore() - Method in class com.squareup.okhttp.CacheControl: If true, this response should not be cached.

O

OkAuthenticator - Interface in com.squareup.okhttp: Deprecated.
replaced with Authenticator in OkHttp 2.0.
OkAuthenticator.Challenge - Class in com.squareup.okhttp: Deprecated.

An RFC 2617 challenge.
OkAuthenticator.Challenge(String, String) - Constructor for class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.
OkAuthenticator.Credential - Class in com.squareup.okhttp: Deprecated.

An RFC 2617 credential.
OkHttpClient - Class in com.squareup.okhttp: Configures and creates HTTP connections.
OkHttpClient() - Constructor for class com.squareup.okhttp.OkHttpClient
OkResponseCache - Interface in com.squareup.okhttp: Deprecated.
removed from the public API in OkHttp 2.0.
onlyIfCached() - Method in class com.squareup.okhttp.CacheControl: This field's name "only-if-cached" is misleading.
open(URL) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
moved to OkUrlFactory.open.

P

parse(Headers) - Static method in class com.squareup.okhttp.CacheControl: Returns the cache directives of headers.
parse(String) - Static method in class com.squareup.okhttp.MediaType: Returns a media type for string, or null if string is not a well-formed media type.
peerCertificates() - Method in class com.squareup.okhttp.Handshake: Returns a possibly-empty list of certificates that identify the remote peer.
peerPrincipal() - Method in class com.squareup.okhttp.Handshake: Returns the remote peer's principle, or null if that peer is anonymous.
Protocol - Enum in com.squareup.okhttp: Contains protocols that OkHttp supports NPN or ALPN selection.
put(URI, URLConnection) - Method in class com.squareup.okhttp.Cache
put(Response) - Method in class com.squareup.okhttp.Cache
put(Response) - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.

R

recycle(Connection) - Method in class com.squareup.okhttp.ConnectionPool: Gives connection to the pool.
recycleCount() - Method in class com.squareup.okhttp.Connection: Returns the number of times this connection has been returned to the connection pool.
requiresConnection() - Method in enum com.squareup.okhttp.ResponseSource: Deprecated.
requiresTunnel() - Method in class com.squareup.okhttp.Connection: Returns true if the HTTP connection needs to tunnel one protocol over another, such as when using HTTPS through an HTTP proxy.
resetIdleStartTime() - Method in class com.squareup.okhttp.Connection
ResponseSource - Enum in com.squareup.okhttp: Deprecated.
removed from the public API in OkHttp 2.0. Use the response's networkResponse() and cacheResponse() to compute how the request was satisfied.
Route - Class in com.squareup.okhttp: The concrete route used by a connection to reach an abstract origin server.
Route(Address, Proxy, InetSocketAddress, boolean) - Constructor for class com.squareup.okhttp.Route
RouteDatabase - Class in com.squareup.okhttp: Deprecated.
removed from the public API in OkHttp 2.0.
RouteDatabase() - Constructor for class com.squareup.okhttp.RouteDatabase: Deprecated.

S

setAuthenticator(OkAuthenticator) - Method in class com.squareup.okhttp.OkHttpClient: Sets the authenticator used to respond to challenges from the remote web server or proxy server.
setCache(Cache) - Method in class com.squareup.okhttp.OkHttpClient
setConnectionPool(ConnectionPool) - Method in class com.squareup.okhttp.OkHttpClient: Sets the connection pool used to recycle HTTP and HTTPS connections.
setConnectTimeout(long, TimeUnit) - Method in class com.squareup.okhttp.OkHttpClient: Sets the default connect timeout for new connections.
setCookieHandler(CookieHandler) - Method in class com.squareup.okhttp.OkHttpClient: Sets the cookie handler to be used to read outgoing cookies and write incoming cookies.
setFollowProtocolRedirects(boolean) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
moved to OkHttpClient.setFollowSslRedirects(boolean).
setFollowSslRedirects(boolean) - Method in class com.squareup.okhttp.OkHttpClient: Configure this client to follow redirects from HTTPS to HTTP and from HTTP to HTTPS.
setHostnameVerifier(HostnameVerifier) - Method in class com.squareup.okhttp.OkHttpClient: Sets the verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
setHttpMinorVersion(int) - Method in class com.squareup.okhttp.Connection
setOkResponseCache(OkResponseCache) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
replaced by OkHttpClient.setCache(com.squareup.okhttp.Cache) which doesn't support custom cache implementations.
setOwner(Object) - Method in class com.squareup.okhttp.Connection
setProtocols(List<Protocol>) - Method in class com.squareup.okhttp.OkHttpClient: Configure the protocols used by this client to communicate with remote servers.
setProxy(Proxy) - Method in class com.squareup.okhttp.OkHttpClient: Sets the HTTP proxy that will be used by connections created by this client.
setProxySelector(ProxySelector) - Method in class com.squareup.okhttp.OkHttpClient: Sets the proxy selection policy to be used if no proxy is specified explicitly.
setReadTimeout(long, TimeUnit) - Method in class com.squareup.okhttp.OkHttpClient: Sets the default read timeout for new connections.
setResponseCache(ResponseCache) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
replaced by OkHttpClient.setCache(com.squareup.okhttp.Cache) which doesn't support custom cache implementations.
setSslSocketFactory(SSLSocketFactory) - Method in class com.squareup.okhttp.OkHttpClient: Sets the socket factory used to secure HTTPS connections.
setTransports(List<String>) - Method in class com.squareup.okhttp.OkHttpClient: Deprecated.
OkHttp 1.5 enforces an enumeration of protocols that can be selected. Please switch to OkHttpClient.setProtocols(java.util.List).
share(Connection) - Method in class com.squareup.okhttp.ConnectionPool: Shares the SPDY connection with the pool.
shouldPostpone(Route) - Method in class com.squareup.okhttp.RouteDatabase: Deprecated.

Returns true if route has failed recently and should be avoided.
sMaxAgeSeconds() - Method in class com.squareup.okhttp.CacheControl: The "s-maxage" directive is the max age for shared caches.
spdyVariant - Variable in enum com.squareup.okhttp.Protocol: Deprecated.
removed from the public API in OkHttp 2.0.
subtype() - Method in class com.squareup.okhttp.MediaType: Returns a specific media subtype, such as "plain" or "png", "mpeg", "mp4" or "xml".

T

toString() - Method in class com.squareup.okhttp.MediaType: Returns the encoded media type, like "text/plain; charset=utf-8", appropriate for use in a Content-Type header.
toString() - Method in class com.squareup.okhttp.OkAuthenticator.Challenge: Deprecated.
toString() - Method in class com.squareup.okhttp.OkAuthenticator.Credential: Deprecated.
trackConditionalCacheHit() - Method in class com.squareup.okhttp.Cache
trackConditionalCacheHit() - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.

Track an conditional GET that was satisfied by this cache.
trackResponse(ResponseSource) - Method in class com.squareup.okhttp.Cache
trackResponse(ResponseSource) - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.

Track an HTTP response being satisfied by source.
TunnelRequest - Class in com.squareup.okhttp: Deprecated.
removed from the public API in OkHttp 2.0.
TunnelRequest(String, int, String, String) - Constructor for class com.squareup.okhttp.TunnelRequest: Deprecated.
type() - Method in class com.squareup.okhttp.MediaType: Returns the high-level media type, such as "text", "image", "audio", "video", or "application".

U

update(Response, Response) - Method in class com.squareup.okhttp.Cache
update(Response, Response) - Method in interface com.squareup.okhttp.OkResponseCache: Deprecated.

Handles a conditional request hit by updating the stored cache response with the headers from network.
updateReadTimeout(int) - Method in class com.squareup.okhttp.Connection
usesCache() - Method in enum com.squareup.okhttp.ResponseSource: Deprecated.

V

valueOf(String) - Static method in enum com.squareup.okhttp.Protocol: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.squareup.okhttp.ResponseSource: Deprecated.

Returns the enum constant of this type with the specified name.
values() - Static method in enum com.squareup.okhttp.Protocol: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.squareup.okhttp.ResponseSource: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P R S T U V