- Cache - Class in okhttp3
-
Caches HTTP and HTTPS responses to the filesystem so they may be reused, saving time and
bandwidth.
- Cache(File, long) - Constructor for class okhttp3.Cache
-
- cache(Cache) - Method in class okhttp3.OkHttpClient.Builder
-
- cache() - Method in class okhttp3.OkHttpClient
-
- CacheControl - Class in okhttp3
-
A Cache-Control header with cache directives from a server or client.
- cacheControl(CacheControl) - Method in class okhttp3.Request.Builder
-
Sets this request's Cache-Control header, replacing any cache control headers already
present.
- cacheControl() - Method in class okhttp3.Request
-
Returns the cache control directives for this response.
- cacheControl() - Method in class okhttp3.Response
-
Returns the cache control directives for this response.
- CacheControl.Builder - Class in okhttp3
-
Builds a Cache-Control request header.
- cacheResponse(Response) - Method in class okhttp3.Response.Builder
-
- cacheResponse() - Method in class okhttp3.Response
-
Returns the raw response received from the cache.
- Call - Interface in okhttp3
-
A call is a request that has been prepared for execution.
- Call.Factory - Interface in okhttp3
-
- Callback - Interface in okhttp3
-
- cancel() - Method in interface okhttp3.Call
-
Cancels the request, if possible.
- cancelAll() - Method in class okhttp3.Dispatcher
-
Cancel all calls currently enqueued or executing.
- certificatePinner() - Method in class okhttp3.Address
-
Returns this address's certificate pinner, or null if this is not an HTTPS address.
- CertificatePinner - Class in okhttp3
-
Constrains which certificates are trusted.
- certificatePinner(CertificatePinner) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the certificate pinner that constrains which certificates are trusted.
- certificatePinner() - Method in class okhttp3.OkHttpClient
-
- CertificatePinner.Builder - Class in okhttp3
-
Builds a configured certificate pinner.
- Challenge - Class in okhttp3
-
An RFC 2617 challenge.
- Challenge(String, String) - Constructor for class okhttp3.Challenge
-
- challenges() - Method in class okhttp3.Response
-
Returns the authorization challenges appropriate for this response's code.
- charset() - Method in class okhttp3.MediaType
-
Returns the charset of this media type, or null if this media type doesn't specify a charset.
- charset(Charset) - Method in class okhttp3.MediaType
-
Returns the charset of this media type, or defaultValue if this media type doesn't
specify a charset.
- charStream() - Method in class okhttp3.ResponseBody
-
Returns the response as a character stream decoded with the charset of the Content-Type header.
- check(String, List<Certificate>) - Method in class okhttp3.CertificatePinner
-
Confirms that at least one of the certificates pinned for hostname is in peerCertificates.
- check(String, Certificate...) - Method in class okhttp3.CertificatePinner
-
- CipherSuite - Enum in okhttp3
-
- cipherSuite() - Method in class okhttp3.Handshake
-
Returns the cipher suite used for the connection.
- cipherSuites(CipherSuite...) - Method in class okhttp3.ConnectionSpec.Builder
-
- cipherSuites(String...) - Method in class okhttp3.ConnectionSpec.Builder
-
- cipherSuites() - Method in class okhttp3.ConnectionSpec
-
Returns the cipher suites to use for a connection.
- CLEARTEXT - Static variable in class okhttp3.ConnectionSpec
-
Unencrypted, unauthenticated connections for http: URLs.
- close() - Method in class okhttp3.Cache
-
- close() - Method in class okhttp3.ResponseBody
-
- code(int) - Method in class okhttp3.Response.Builder
-
- code() - Method in class okhttp3.Response
-
Returns the HTTP status code.
- COMPATIBLE_TLS - Static variable in class okhttp3.ConnectionSpec
-
A backwards-compatible fallback connection for interop with obsolete servers.
- Connection - Interface in okhttp3
-
The sockets and streams of an HTTP, HTTPS, or HTTPS+SPDY connection.
- connection() - Method in interface okhttp3.Interceptor.Chain
-
- connectionCount() - Method in class okhttp3.ConnectionPool
-
Returns total number of connections in the pool.
- ConnectionPool - Class in okhttp3
-
Manages reuse of HTTP and SPDY connections for reduced network latency.
- ConnectionPool() - Constructor for class okhttp3.ConnectionPool
-
Create a new connection pool with tuning parameters appropriate for a single-user application.
- ConnectionPool(int, long, TimeUnit) - Constructor for class okhttp3.ConnectionPool
-
- connectionPool(ConnectionPool) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the connection pool used to recycle HTTP and HTTPS connections.
- connectionPool() - Method in class okhttp3.OkHttpClient
-
- ConnectionSpec - Class in okhttp3
-
Specifies configuration for the socket connection that HTTP traffic travels through.
- ConnectionSpec.Builder - Class in okhttp3
-
- connectionSpecs() - Method in class okhttp3.Address
-
- connectionSpecs(List<ConnectionSpec>) - Method in class okhttp3.OkHttpClient.Builder
-
- connectionSpecs() - Method in class okhttp3.OkHttpClient
-
- connectTimeout(long, TimeUnit) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the default connect timeout for new connections.
- connectTimeoutMillis() - Method in class okhttp3.OkHttpClient
-
Default connect timeout (in milliseconds).
- contentLength() - Method in class okhttp3.FormBody
-
- contentLength() - Method in class okhttp3.MultipartBody
-
- contentLength() - Method in class okhttp3.RequestBody
-
- contentLength() - Method in class okhttp3.ResponseBody
-
- contentType() - Method in class okhttp3.FormBody
-
- contentType() - Method in class okhttp3.MultipartBody
-
- contentType() - Method in class okhttp3.RequestBody
-
Returns the Content-Type header for this body.
- contentType() - Method in class okhttp3.ResponseBody
-
- Cookie - Class in okhttp3
-
- Cookie.Builder - Class in okhttp3
-
Builds a cookie.
- CookieJar - Interface in okhttp3
-
Provides policy and persistence for HTTP cookies.
- cookieJar(CookieJar) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the handler that can accept cookies from incoming HTTP responses and provides cookies to
outgoing HTTP requests.
- cookieJar() - Method in class okhttp3.OkHttpClient
-
- create(RequestBody) - Static method in class okhttp3.MultipartBody.Part
-
- create(Headers, RequestBody) - Static method in class okhttp3.MultipartBody.Part
-
- create(MediaType, String) - Static method in class okhttp3.RequestBody
-
Returns a new request body that transmits content.
- create(MediaType, ByteString) - Static method in class okhttp3.RequestBody
-
Returns a new request body that transmits content.
- create(MediaType, byte[]) - Static method in class okhttp3.RequestBody
-
Returns a new request body that transmits content.
- create(MediaType, byte[], int, int) - Static method in class okhttp3.RequestBody
-
Returns a new request body that transmits content.
- create(MediaType, File) - Static method in class okhttp3.RequestBody
-
Returns a new request body that transmits the content of file.
- create(MediaType, String) - Static method in class okhttp3.ResponseBody
-
Returns a new response body that transmits content.
- create(MediaType, byte[]) - Static method in class okhttp3.ResponseBody
-
Returns a new response body that transmits content.
- create(MediaType, long, BufferedSource) - Static method in class okhttp3.ResponseBody
-
Returns a new response body that transmits content.
- createFormData(String, String) - Static method in class okhttp3.MultipartBody.Part
-
- createFormData(String, String, RequestBody) - Static method in class okhttp3.MultipartBody.Part
-
- Credentials - Class in okhttp3
-
Factory for HTTP authorization credentials.
- handshake() - Method in interface okhttp3.Connection
-
Returns the TLS handshake used to establish this connection, or null if the connection is not
HTTPS.
- Handshake - Class in okhttp3
-
A record of a TLS handshake.
- handshake(Handshake) - Method in class okhttp3.Response.Builder
-
- handshake() - Method in class okhttp3.Response
-
Returns the TLS handshake of the connection that carried this response, or null if the response
was received without TLS.
- hashCode() - Method in class okhttp3.Address
-
- hashCode() - Method in class okhttp3.Challenge
-
- hashCode() - Method in class okhttp3.ConnectionSpec
-
- hashCode() - Method in class okhttp3.Cookie
-
- hashCode() - Method in class okhttp3.Handshake
-
- hashCode() - Method in class okhttp3.HttpUrl
-
- hashCode() - Method in class okhttp3.MediaType
-
- hashCode() - Method in class okhttp3.Route
-
- head() - Method in class okhttp3.Request.Builder
-
- header(String, String) - Method in class okhttp3.Request.Builder
-
Sets the header named name to value.
- header(String) - Method in class okhttp3.Request
-
- header(String, String) - Method in class okhttp3.Response.Builder
-
Sets the header named name to value.
- header(String) - Method in class okhttp3.Response
-
- header(String, String) - Method in class okhttp3.Response
-
- Headers - Class in okhttp3
-
The header fields of a single HTTP message.
- headers(Headers) - Method in class okhttp3.Request.Builder
-
Removes all headers on this builder and adds headers.
- headers() - Method in class okhttp3.Request
-
- headers(String) - Method in class okhttp3.Request
-
- headers(Headers) - Method in class okhttp3.Response.Builder
-
Removes all headers on this builder and adds headers.
- headers(String) - Method in class okhttp3.Response
-
- headers() - Method in class okhttp3.Response
-
- Headers.Builder - Class in okhttp3
-
- hitCount() - Method in class okhttp3.Cache
-
- host(String) - Method in class okhttp3.HttpUrl.Builder
-
- host() - Method in class okhttp3.HttpUrl
-
- hostnameVerifier() - Method in class okhttp3.Address
-
Returns the hostname verifier, or null if this is not an HTTPS address.
- hostnameVerifier(HostnameVerifier) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the verifier used to confirm that response certificates apply to requested hostnames for
HTTPS connections.
- hostnameVerifier() - Method in class okhttp3.OkHttpClient
-
- hostOnly() - Method in class okhttp3.Cookie
-
Returns true if this cookie's domain should be interpreted as a single host name, or false if
it should be interpreted as a pattern.
- hostOnlyDomain(String) - Method in class okhttp3.Cookie.Builder
-
Set the host-only domain for this cookie.
- httpOnly() - Method in class okhttp3.Cookie.Builder
-
- httpOnly() - Method in class okhttp3.Cookie
-
Returns true if this cookie should be limited to only HTTP APIs.
- HttpUrl - Class in okhttp3
-
A uniform resource locator (URL) with a scheme of either http or https.
- HttpUrl.Builder - Class in okhttp3
-
- idleConnectionCount() - Method in class okhttp3.ConnectionPool
-
Returns the number of idle connections in the pool.
- initialize() - Method in class okhttp3.Cache
-
Initialize the cache.
- intercept(Interceptor.Chain) - Method in interface okhttp3.Interceptor
-
- Interceptor - Interface in okhttp3
-
Observes, modifies, and potentially short-circuits requests going out and the corresponding
requests coming back in.
- Interceptor.Chain - Interface in okhttp3
-
- interceptors() - Method in class okhttp3.OkHttpClient.Builder
-
Returns a modifiable list of interceptors that observe the full span of each call: from
before the connection is established (if any) until after the response source is selected
(either the origin server, cache, or both).
- interceptors() - Method in class okhttp3.OkHttpClient
-
Returns an immutable list of interceptors that observe the full span of each call: from before
the connection is established (if any) until after the response source is selected (either the
origin server, cache, or both).
- isCanceled() - Method in interface okhttp3.Call
-
- isClosed() - Method in class okhttp3.Cache
-
- isCompatible(SSLSocket) - Method in class okhttp3.ConnectionSpec
-
Returns true if the socket, as currently configured, supports this connection spec.
- isExecuted() - Method in interface okhttp3.Call
-
- isHttps() - Method in class okhttp3.HttpUrl
-
- isHttps() - Method in class okhttp3.Request
-
- isPrivate() - Method in class okhttp3.CacheControl
-
- isPublic() - Method in class okhttp3.CacheControl
-
- isRedirect() - Method in class okhttp3.Response
-
Returns true if this response redirects to another resource.
- isSuccessful() - Method in class okhttp3.Response
-
Returns true if the code is in [200..300), which means the request was successfully received,
understood, and accepted.
- isTls() - Method in class okhttp3.ConnectionSpec
-
- name(String) - Method in class okhttp3.Cookie.Builder
-
- name() - Method in class okhttp3.Cookie
-
Returns a non-empty string with this cookie's name.
- name(int) - Method in class okhttp3.FormBody
-
- name(int) - Method in class okhttp3.Headers
-
Returns the field at position.
- names() - Method in class okhttp3.Headers
-
Returns an immutable case-insensitive set of header names.
- networkCount() - Method in class okhttp3.Cache
-
- networkInterceptors() - Method in class okhttp3.OkHttpClient.Builder
-
Returns a modifiable list of interceptors that observe a single network request and response.
- networkInterceptors() - Method in class okhttp3.OkHttpClient
-
Returns an immutable list of interceptors that observe a single network request and response.
- networkResponse(Response) - Method in class okhttp3.Response.Builder
-
- networkResponse() - Method in class okhttp3.Response
-
Returns the raw response received from the network.
- newBuilder() - Method in class okhttp3.Headers
-
- newBuilder() - Method in class okhttp3.HttpUrl
-
- newBuilder(String) - Method in class okhttp3.HttpUrl
-
Returns a builder for the URL that would be retrieved by following link from this URL,
or null if the resulting URL is not well-formed.
- newBuilder() - Method in class okhttp3.OkHttpClient
-
- newBuilder() - Method in class okhttp3.Request
-
- newBuilder() - Method in class okhttp3.Response
-
- newCall(Request) - Method in interface okhttp3.Call.Factory
-
- newCall(Request) - Method in class okhttp3.OkHttpClient
-
Prepares the request to be executed at some point in the future.
- NO_COOKIES - Static variable in interface okhttp3.CookieJar
-
A cookie jar that never accepts any cookies.
- noCache() - Method in class okhttp3.CacheControl.Builder
-
Don't accept an unvalidated cached response.
- noCache() - Method in class okhttp3.CacheControl
-
In a response, this field's name "no-cache" is misleading.
- NONE - Static variable in interface okhttp3.Authenticator
-
An authenticator that knows no credentials and makes no attempt to authenticate.
- noStore() - Method in class okhttp3.CacheControl.Builder
-
Don't store the server's response in any cache.
- noStore() - Method in class okhttp3.CacheControl
-
If true, this response should not be cached.
- noTransform() - Method in class okhttp3.CacheControl.Builder
-
Don't accept a transformed response.
- noTransform() - Method in class okhttp3.CacheControl
-
- PARALLEL - Static variable in class okhttp3.MultipartBody
-
This type is syntactically identical to "multipart/mixed", but the semantics are different.
- parse(Headers) - Static method in class okhttp3.CacheControl
-
Returns the cache directives of headers.
- parse(HttpUrl, String) - Static method in class okhttp3.Cookie
-
Attempt to parse a Set-Cookie HTTP header value setCookie as a cookie.
- parse(String) - Static method in class okhttp3.HttpUrl
-
Returns a new HttpUrl representing url if it is a well-formed HTTP or HTTPS
URL, or null if it isn't.
- parse(String) - Static method in class okhttp3.MediaType
-
Returns a media type for string, or null if string is not a well-formed media
type.
- parseAll(HttpUrl, Headers) - Static method in class okhttp3.Cookie
-
Returns all of the cookies from a set of HTTP response headers.
- part(int) - Method in class okhttp3.MultipartBody
-
- parts() - Method in class okhttp3.MultipartBody
-
- password(String) - Method in class okhttp3.HttpUrl.Builder
-
- password() - Method in class okhttp3.HttpUrl
-
Returns the decoded password, or an empty string if none is present.
- patch(RequestBody) - Method in class okhttp3.Request.Builder
-
- path(String) - Method in class okhttp3.Cookie.Builder
-
- path() - Method in class okhttp3.Cookie
-
Returns this cookie's path.
- pathSegments() - Method in class okhttp3.HttpUrl
-
- pathSize() - Method in class okhttp3.HttpUrl
-
- peekBody(long) - Method in class okhttp3.Response
-
Peeks up to byteCount bytes from the response body and returns them as a new response
body.
- peerCertificates() - Method in class okhttp3.Handshake
-
Returns a possibly-empty list of certificates that identify the remote peer.
- peerPrincipal() - Method in class okhttp3.Handshake
-
Returns the remote peer's principle, or null if that peer is anonymous.
- persistent() - Method in class okhttp3.Cookie
-
Returns true if this cookie expires at the end of the current session.
- pin(Certificate) - Static method in class okhttp3.CertificatePinner
-
Returns the SHA-1 of certificate's public key.
- port(int) - Method in class okhttp3.HttpUrl.Builder
-
- port() - Method in class okhttp3.HttpUrl
-
Returns the explicitly-specified port if one was provided, or the default port for this URL's
scheme.
- post(RequestBody) - Method in class okhttp3.Request.Builder
-
- priorResponse(Response) - Method in class okhttp3.Response.Builder
-
- priorResponse() - Method in class okhttp3.Response
-
Returns the response for the HTTP redirect or authorization challenge that triggered this
response, or null if this response wasn't triggered by an automatic retry.
- proceed(Request) - Method in interface okhttp3.Interceptor.Chain
-
- protocol() - Method in interface okhttp3.Connection
-
Returns the protocol negotiated by this connection, or
Protocol.HTTP_1_1 if no protocol
has been negotiated.
- Protocol - Enum in okhttp3
-
Protocols that OkHttp implements for
ALPN selection.
- protocol(Protocol) - Method in class okhttp3.Response.Builder
-
- protocol() - Method in class okhttp3.Response
-
- protocols() - Method in class okhttp3.Address
-
Returns the protocols the client supports.
- protocols(List<Protocol>) - Method in class okhttp3.OkHttpClient.Builder
-
Configure the protocols used by this client to communicate with remote servers.
- protocols() - Method in class okhttp3.OkHttpClient
-
- proxy() - Method in class okhttp3.Address
-
Returns this address's explicitly-specified HTTP proxy, or null to delegate to the
proxy selector.
- proxy(Proxy) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the HTTP proxy that will be used by connections created by this client.
- proxy() - Method in class okhttp3.OkHttpClient
-
- proxy() - Method in class okhttp3.Route
-
Returns the
Proxy of this route.
- proxyAuthenticator() - Method in class okhttp3.Address
-
Returns the client's proxy authenticator.
- proxyAuthenticator(Authenticator) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the authenticator used to respond to challenges from proxy servers.
- proxyAuthenticator() - Method in class okhttp3.OkHttpClient
-
- proxySelector() - Method in class okhttp3.Address
-
Returns this address's proxy selector.
- proxySelector(ProxySelector) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the proxy selection policy to be used if no
proxy is specified
explicitly.
- proxySelector() - Method in class okhttp3.OkHttpClient
-
- put(RequestBody) - Method in class okhttp3.Request.Builder
-
- saveFromResponse(HttpUrl, List<Cookie>) - Method in interface okhttp3.CookieJar
-
Saves cookies from an HTTP response to this store according to this jar's policy.
- scheme() - Method in class okhttp3.Challenge
-
Returns the authentication scheme, like Basic.
- scheme(String) - Method in class okhttp3.HttpUrl.Builder
-
- scheme() - Method in class okhttp3.HttpUrl
-
Returns either "http" or "https".
- secure() - Method in class okhttp3.Cookie.Builder
-
- secure() - Method in class okhttp3.Cookie
-
Returns true if this cookie should be limited to only HTTPS requests.
- set(String, String) - Method in class okhttp3.Headers.Builder
-
Set a field with the specified value.
- setEncodedPathSegment(int, String) - Method in class okhttp3.HttpUrl.Builder
-
- setEncodedQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
- setMaxRequests(int) - Method in class okhttp3.Dispatcher
-
Set the maximum number of requests to execute concurrently.
- setMaxRequestsPerHost(int) - Method in class okhttp3.Dispatcher
-
Set the maximum number of requests for each host to execute concurrently.
- setPathSegment(int, String) - Method in class okhttp3.HttpUrl.Builder
-
- setQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
- setType(MediaType) - Method in class okhttp3.MultipartBody.Builder
-
Set the MIME type.
- size() - Method in class okhttp3.Cache
-
- size() - Method in class okhttp3.FormBody
-
The number of key-value pairs in this form-encoded body.
- size() - Method in class okhttp3.Headers
-
Returns the number of field values.
- size() - Method in class okhttp3.MultipartBody
-
The number of parts in this multipart body.
- sMaxAgeSeconds() - Method in class okhttp3.CacheControl
-
The "s-maxage" directive is the max age for shared caches.
- socket() - Method in interface okhttp3.Connection
-
Returns the socket that this connection is using.
- socketAddress() - Method in class okhttp3.Route
-
- socketFactory() - Method in class okhttp3.Address
-
Returns the socket factory for new connections.
- socketFactory(SocketFactory) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the socket factory used to create connections.
- socketFactory() - Method in class okhttp3.OkHttpClient
-
- source() - Method in class okhttp3.ResponseBody
-
- sslSocketFactory() - Method in class okhttp3.Address
-
Returns the SSL socket factory, or null if this is not an HTTPS address.
- sslSocketFactory(SSLSocketFactory) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the socket factory used to secure HTTPS connections.
- sslSocketFactory() - Method in class okhttp3.OkHttpClient
-
- string() - Method in class okhttp3.ResponseBody
-
Returns the response as a string decoded with the charset of the Content-Type header.
- subtype() - Method in class okhttp3.MediaType
-
Returns a specific media subtype, such as "plain" or "png", "mpeg", "mp4" or "xml".
- supportsTlsExtensions(boolean) - Method in class okhttp3.ConnectionSpec.Builder
-
- supportsTlsExtensions() - Method in class okhttp3.ConnectionSpec
-
- SYSTEM - Static variable in interface okhttp3.Dns
-