OkHttpClient (OkHttp 1.6.0 API)

java.lang.Object
- com.squareup.okhttp.OkHttpClient

All Implemented Interfaces:

Cloneable, URLStreamHandlerFactory
```
public final class OkHttpClient
extends Object
implements URLStreamHandlerFactory, Cloneable
```
Configures and creates HTTP connections. Most applications can use a single OkHttpClient for all of their HTTP requests - benefiting from a shared response cache, thread pool, connection re-use, etc. Instances of OkHttpClient are intended to be fully configured before they're shared - once shared they should be treated as immutable and can safely be used to concurrently open new connections. If required, threads can call clone() to make a shallow copy of the OkHttpClient that can be safely modified with further configuration changes.

Constructor Summary

Constructors
Constructor and Description

OkHttpClient()

Constructors
Constructor and Description
`OkHttpClient()`

Method Summary

Methods
Modifier and Type	Method and Description
`OkHttpClient`	`clone()` Returns a shallow copy of this OkHttpClient.
`URLStreamHandler`	`createURLStreamHandler(String protocol)` Deprecated. moved to `OkUrlFactory.createURLStreamHandler`.
`OkAuthenticator`	`getAuthenticator()`
`Cache`	`getCache()`
`ConnectionPool`	`getConnectionPool()`
`int`	`getConnectTimeout()` Default connect timeout (in milliseconds).
`CookieHandler`	`getCookieHandler()`
`boolean`	`getFollowProtocolRedirects()` Deprecated. moved to `getFollowSslRedirects()`.
`boolean`	`getFollowSslRedirects()`
`HostnameVerifier`	`getHostnameVerifier()`
`OkResponseCache`	`getOkResponseCache()` Deprecated. replaced by `getCache()` which doesn't support custom cache implementations.
`List<Protocol>`	`getProtocols()`
`Proxy`	`getProxy()`
`ProxySelector`	`getProxySelector()`
`int`	`getReadTimeout()` Default read timeout (in milliseconds).
`ResponseCache`	`getResponseCache()` Deprecated. replaced by `getCache()` which doesn't support custom cache implementations.
`RouteDatabase`	`getRoutesDatabase()` Deprecated. removed from the public API in OkHttp 2.0.
`SSLSocketFactory`	`getSslSocketFactory()`
`List<String>`	`getTransports()` Deprecated. OkHttp 1.5 enforces an enumeration of `protocols` that can be selected. Please switch to `getProtocols()`.
`HttpURLConnection`	`open(URL url)` Deprecated. moved to `OkUrlFactory.open`.
`OkHttpClient`	`setAuthenticator(OkAuthenticator authenticator)` Sets the authenticator used to respond to challenges from the remote web server or proxy server.
`OkHttpClient`	`setCache(Cache cache)`
`OkHttpClient`	`setConnectionPool(ConnectionPool connectionPool)` Sets the connection pool used to recycle HTTP and HTTPS connections.
`void`	`setConnectTimeout(long timeout, TimeUnit unit)` Sets the default connect timeout for new connections.
`OkHttpClient`	`setCookieHandler(CookieHandler cookieHandler)` Sets the cookie handler to be used to read outgoing cookies and write incoming cookies.
`OkHttpClient`	`setFollowProtocolRedirects(boolean followProtocolRedirects)` Deprecated. moved to `setFollowSslRedirects(boolean)`.
`OkHttpClient`	`setFollowSslRedirects(boolean followProtocolRedirects)` Configure this client to follow redirects from HTTPS to HTTP and from HTTP to HTTPS.
`OkHttpClient`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)` Sets the verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
`OkHttpClient`	`setOkResponseCache(OkResponseCache responseCache)` Deprecated. replaced by `setCache(com.squareup.okhttp.Cache)` which doesn't support custom cache implementations.
`OkHttpClient`	`setProtocols(List<Protocol> protocols)` Configure the protocols used by this client to communicate with remote servers.
`OkHttpClient`	`setProxy(Proxy proxy)` Sets the HTTP proxy that will be used by connections created by this client.
`OkHttpClient`	`setProxySelector(ProxySelector proxySelector)` Sets the proxy selection policy to be used if no `proxy` is specified explicitly.
`void`	`setReadTimeout(long timeout, TimeUnit unit)` Sets the default read timeout for new connections.
`OkHttpClient`	`setResponseCache(ResponseCache responseCache)` Deprecated. replaced by `setCache(com.squareup.okhttp.Cache)` which doesn't support custom cache implementations.
`OkHttpClient`	`setSslSocketFactory(SSLSocketFactory sslSocketFactory)` Sets the socket factory used to secure HTTPS connections.
`OkHttpClient`	`setTransports(List<String> transports)` Deprecated. OkHttp 1.5 enforces an enumeration of `protocols` that can be selected. Please switch to `setProtocols(java.util.List)`.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OkHttpClient
```
public OkHttpClient()
```
- Method Detail
  - setConnectTimeout
```
public void setConnectTimeout(long timeout,
                     TimeUnit unit)
```
    Sets the default connect timeout for new connections. A value of 0 means no timeout.
    
    See Also:
    URLConnection.setConnectTimeout(int)
  - getConnectTimeout
```
public int getConnectTimeout()
```
    Default connect timeout (in milliseconds).
  - setReadTimeout
```
public void setReadTimeout(long timeout,
                  TimeUnit unit)
```
    Sets the default read timeout for new connections. A value of 0 means no timeout.
    
    See Also:
    URLConnection.setReadTimeout(int)
  - getReadTimeout
```
public int getReadTimeout()
```
    Default read timeout (in milliseconds).
  - setProxy
```
public OkHttpClient setProxy(Proxy proxy)
```
    Sets the HTTP proxy that will be used by connections created by this client. This takes precedence over setProxySelector(java.net.ProxySelector), which is only honored when this proxy is null (which it is by default). To disable proxy use completely, call setProxy(Proxy.NO_PROXY).
  - getProxy
```
public Proxy getProxy()
```
  - setProxySelector
```
public OkHttpClient setProxySelector(ProxySelector proxySelector)
```
    Sets the proxy selection policy to be used if no proxy is specified explicitly. The proxy selector may return multiple proxies; in that case they will be tried in sequence until a successful connection is established.
    If unset, the system-wide default proxy selector will be used.
  - getProxySelector
```
public ProxySelector getProxySelector()
```
  - setCookieHandler
```
public OkHttpClient setCookieHandler(CookieHandler cookieHandler)
```
    Sets the cookie handler to be used to read outgoing cookies and write incoming cookies.
    If unset, the system-wide default cookie handler will be used.
  - getCookieHandler
```
public CookieHandler getCookieHandler()
```
  - setResponseCache
```
@Deprecated
public OkHttpClient setResponseCache(ResponseCache responseCache)
```
    Deprecated. replaced by setCache(com.squareup.okhttp.Cache) which doesn't support custom cache implementations.
    
    Sets the response cache to be used to read and write cached responses.
  - getResponseCache
```
@Deprecated
public ResponseCache getResponseCache()
```
    Deprecated. replaced by getCache() which doesn't support custom cache implementations.
  - setOkResponseCache
```
@Deprecated
public OkHttpClient setOkResponseCache(OkResponseCache responseCache)
```
    Deprecated. replaced by setCache(com.squareup.okhttp.Cache) which doesn't support custom cache implementations.
  - getOkResponseCache
```
@Deprecated
public OkResponseCache getOkResponseCache()
```
    Deprecated. replaced by getCache() which doesn't support custom cache implementations.
  - setCache
```
public OkHttpClient setCache(Cache cache)
```
  - getCache
```
public Cache getCache()
```
  - setSslSocketFactory
```
public OkHttpClient setSslSocketFactory(SSLSocketFactory sslSocketFactory)
```
    Sets the socket factory used to secure HTTPS connections.
    If unset, a lazily created SSL socket factory will be used.
  - getSslSocketFactory
```
public SSLSocketFactory getSslSocketFactory()
```
  - setHostnameVerifier
```
public OkHttpClient setHostnameVerifier(HostnameVerifier hostnameVerifier)
```
    Sets the verifier used to confirm that response certificates apply to requested hostnames for HTTPS connections.
    If unset, the system-wide default hostname verifier will be used.
  - getHostnameVerifier
```
public HostnameVerifier getHostnameVerifier()
```
  - setAuthenticator
```
public OkHttpClient setAuthenticator(OkAuthenticator authenticator)
```
    Sets the authenticator used to respond to challenges from the remote web server or proxy server.
    If unset, the system-wide default authenticator will be used.
  - getAuthenticator
```
public OkAuthenticator getAuthenticator()
```
  - setConnectionPool
```
public OkHttpClient setConnectionPool(ConnectionPool connectionPool)
```
    Sets the connection pool used to recycle HTTP and HTTPS connections.
    If unset, the system-wide default connection pool will be used.
  - getConnectionPool
```
public ConnectionPool getConnectionPool()
```
  - setFollowProtocolRedirects
```
@Deprecated
public OkHttpClient setFollowProtocolRedirects(boolean followProtocolRedirects)
```
    Deprecated. moved to setFollowSslRedirects(boolean).
  - getFollowProtocolRedirects
```
@Deprecated
public boolean getFollowProtocolRedirects()
```
    Deprecated. moved to getFollowSslRedirects().
  - setFollowSslRedirects
```
public OkHttpClient setFollowSslRedirects(boolean followProtocolRedirects)
```
    Configure this client to follow redirects from HTTPS to HTTP and from HTTP to HTTPS.
    If unset, protocol redirects will be followed. This is different than the built-in HttpURLConnection's default.
  - getFollowSslRedirects
```
public boolean getFollowSslRedirects()
```
  - getRoutesDatabase
```
@Deprecated
public RouteDatabase getRoutesDatabase()
```
    Deprecated. removed from the public API in OkHttp 2.0.
  - setTransports
```
@Deprecated
public OkHttpClient setTransports(List<String> transports)
```
    Deprecated. OkHttp 1.5 enforces an enumeration of protocols that can be selected. Please switch to setProtocols(java.util.List).
  - setProtocols
```
public OkHttpClient setProtocols(List<Protocol> protocols)
```
    Configure the protocols used by this client to communicate with remote servers. By default this client will prefer the most efficient transport available, falling back to more ubiquitous protocols. Applications should only call this method to avoid specific compatibility problems, such as web servers that behave incorrectly when SPDY is enabled.
    The following protocols are currently supported:
    This is an evolving set. Future releases may drop support for transitional protocols (like spdy/3.1), in favor of their successors (spdy/4 or http/2.0). The http/1.1 transport will never be dropped.
    If multiple protocols are specified, NPN will be used to negotiate a transport. Future releases may use another mechanism (such as ALPN) to negotiate a transport.
    Parameters:
    protocols - the protocols to use, in order of preference. The list must contain "http/1.1". It must not contain null.
  - getTransports
```
@Deprecated
public List<String> getTransports()
```
    Deprecated. OkHttp 1.5 enforces an enumeration of protocols that can be selected. Please switch to getProtocols().
  - getProtocols
```
public List<Protocol> getProtocols()
```
  - open
```
@Deprecated
public HttpURLConnection open(URL url)
```
    Deprecated. moved to OkUrlFactory.open.
  - clone
```
public OkHttpClient clone()
```
    Returns a shallow copy of this OkHttpClient.
    
    Overrides:
    
    clone in class Object
  - createURLStreamHandler
```
@Deprecated
public URLStreamHandler createURLStreamHandler(String protocol)
```
    Deprecated. moved to OkUrlFactory.createURLStreamHandler.
    Creates a URLStreamHandler as a URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory).
    This code configures OkHttp to handle all HTTP and HTTPS connections created with URL.openConnection():
```
   OkHttpClient okHttpClient = new OkHttpClient();
   URL.setURLStreamHandlerFactory(okHttpClient);
 
```
    Specified by:
    
    createURLStreamHandler in interface URLStreamHandlerFactory

Class OkHttpClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OkHttpClient

Method Detail

setConnectTimeout

getConnectTimeout

setReadTimeout

getReadTimeout

setProxy

getProxy

setProxySelector

getProxySelector

setCookieHandler

getCookieHandler

setResponseCache

getResponseCache

setOkResponseCache

getOkResponseCache

setCache

getCache

setSslSocketFactory

getSslSocketFactory

setHostnameVerifier

getHostnameVerifier

setAuthenticator

getAuthenticator

setConnectionPool

getConnectionPool

setFollowProtocolRedirects

getFollowProtocolRedirects

setFollowSslRedirects

getFollowSslRedirects

getRoutesDatabase

setTransports

setProtocols

getTransports

getProtocols

open

clone

createURLStreamHandler