- abort() - Method in interface okhttp3.internal.cache.CacheRequest
-
- abort() - Method in class okhttp3.internal.cache.DiskLruCache.Editor
-
Aborts this edit.
- abortUnlessCommitted() - Method in class okhttp3.internal.cache.DiskLruCache.Editor
-
- acceptHeader(String) - Static method in class okhttp3.internal.ws.WebSocketProtocol
-
- access_token - Variable in class okhttp3.slack.OAuthSession
-
- AccessHeaders - Class in okhttp3.recipes
-
- AccessHeaders() - Constructor for class okhttp3.recipes.AccessHeaders
-
- acquire(RealConnection) - Method in class okhttp3.internal.connection.StreamAllocation
-
Use this allocation to hold connection.
- add(String, String...) - Method in class okhttp3.CertificatePinner.Builder
-
Pins certificates for pattern.
- add(String, String) - Method in class okhttp3.FormBody.Builder
-
- add(String) - Method in class okhttp3.Headers.Builder
-
Add an header line containing a field name, a literal colon, and a value.
- add(String, String) - Method in class okhttp3.Headers.Builder
-
Add a field with the specified value.
- addConnectException(IOException) - Method in exception okhttp3.internal.connection.RouteException
-
- addEncoded(String, String) - Method in class okhttp3.FormBody.Builder
-
- addEncodedPathSegment(String) - Method in class okhttp3.HttpUrl.Builder
-
- addEncodedPathSegments(String) - Method in class okhttp3.HttpUrl.Builder
-
Adds a set of encoded path segments separated by a slash (either \ or /).
- addEncodedQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
Adds the pre-encoded query parameter to this URL's query string.
- addFormDataPart(String, String) - Method in class okhttp3.MultipartBody.Builder
-
Add a form data part to the body.
- addFormDataPart(String, String, RequestBody) - Method in class okhttp3.MultipartBody.Builder
-
Add a form data part to the body.
- addHeader(String) - Method in class okhttp3.mockwebserver.MockResponse
-
Adds header as an HTTP header.
- addHeader(String, Object) - Method in class okhttp3.mockwebserver.MockResponse
-
Adds a new header with the name and value.
- addHeader(String, String) - Method in class okhttp3.Request.Builder
-
Adds a header with name and value.
- addHeader(String, String) - Method in class okhttp3.Response.Builder
-
Adds a header with name and value.
- addHeaderLenient(String, Object) - Method in class okhttp3.mockwebserver.MockResponse
-
Adds a new header with the name and value.
- addInterceptor(Interceptor) - Method in class okhttp3.OkHttpClient.Builder
-
- addLenient(Headers.Builder, String) - Method in class okhttp3.internal.Internal
-
- addLenient(Headers.Builder, String, String) - Method in class okhttp3.internal.Internal
-
- addNetworkInterceptor(Interceptor) - Method in class okhttp3.OkHttpClient.Builder
-
- addPart(RequestBody) - Method in class okhttp3.MultipartBody.Builder
-
Add a part to the body.
- addPart(Headers, RequestBody) - Method in class okhttp3.MultipartBody.Builder
-
Add a part to the body.
- addPart(MultipartBody.Part) - Method in class okhttp3.MultipartBody.Builder
-
Add a part to the body.
- addPathSegment(String) - Method in class okhttp3.HttpUrl.Builder
-
- addPathSegments(String) - Method in class okhttp3.HttpUrl.Builder
-
Adds a set of path segments separated by a slash (either \ or /).
- addProxy(Proxy) - Method in class okhttp3.FakeProxySelector
-
- addQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
Encodes the query parameter using UTF-8 and adds it to this URL's query string.
- addRequestProperty(String, String) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- Address - Class in okhttp3
-
A specification for a connection to an origin server.
- Address(String, int, Dns, SocketFactory, SSLSocketFactory, HostnameVerifier, CertificatePinner, Authenticator, Proxy, List<Protocol>, List<ConnectionSpec>, ProxySelector) - Constructor for class okhttp3.Address
-
- address - Variable in class okhttp3.internal.connection.StreamAllocation
-
- address() - Method in class okhttp3.Route
-
- addTrustedCertificate(X509Certificate) - Method in class okhttp3.internal.tls.SslClient.Builder
-
Add a certificate authority that this client trusts.
- after() - Method in class okhttp3.mockwebserver.MockWebServer
-
- afterHandshake(SSLSocket) - Method in class okhttp3.internal.platform.Platform
-
- allEnabledCipherSuites() - Method in class okhttp3.ConnectionSpec.Builder
-
- allEnabledTlsVersions() - Method in class okhttp3.ConnectionSpec.Builder
-
- allocate(int) - Method in class okhttp3.FakeDns
-
Allocates and returns count fake addresses like [255.0.0.100, 255.0.0.101].
- allocationLimit - Variable in class okhttp3.internal.connection.RealConnection
-
The maximum number of concurrent streams that can be carried by this connection.
- allocations - Variable in class okhttp3.internal.connection.RealConnection
-
Current streams carried by this connection.
- allowInsecure - Variable in class okhttp3.curl.Main
-
- allSubjectAltNames(X509Certificate) - Static method in class okhttp3.internal.tls.OkHostnameVerifier
-
- alpnProtocolNames(List<Protocol>) - Static method in class okhttp3.internal.platform.Platform
-
- ALTERNATIVE - Static variable in class okhttp3.MultipartBody
-
The "multipart/alternative" type is syntactically identical to "multipart/mixed", but the
semantics are different.
- AndroidInternal - Class in okhttp3
-
Back doors to enable the use of OkHttp within the Android platform libraries.
- AndroidShimResponseCache - Class in okhttp3
-
A class provided for use by Android so that it can continue supporting a
ResponseCache
with stats.
- appendingSink(File) - Method in interface okhttp3.internal.io.FileSystem
-
Writes to file, appending if data is already present.
- appendingSink(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- apply(ConnectionSpec, SSLSocket, boolean) - Method in class okhttp3.internal.Internal
-
- apply(Statement, Description) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- assertRequests(String...) - Method in class okhttp3.FakeDns
-
- assertResponseCookies(String...) - Method in class okhttp3.RecordingCookieJar
-
- AsynchronousGet - Class in okhttp3.recipes
-
- AsynchronousGet() - Constructor for class okhttp3.recipes.AsynchronousGet
-
- authenticate(Route, Response) - Method in interface okhttp3.Authenticator
-
Returns a request that includes a credential to satisfy an authentication challenge in response.
- authenticate(Route, Response) - Method in class okhttp3.JavaNetAuthenticator
-
- Authenticate - Class in okhttp3.recipes
-
- Authenticate() - Constructor for class okhttp3.recipes.Authenticate
-
- Authenticator - Interface in okhttp3
-
Responds to an authentication challenge from either a remote web server or a proxy server.
- authenticator() - Method in class okhttp3.OkHttpClient
-
- authenticator(Authenticator) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the authenticator used to respond to challenges from origin servers.
- authorizeUrl(String, HttpUrl, ByteString, String) - Method in class okhttp3.slack.SlackApi
-
See https://api.slack.com/docs/oauth.
- AutobahnTester - Class in okhttp3
-
- AutobahnTester() - Constructor for class okhttp3.AutobahnTester
-
- awaitAccessToken(Timeout) - Method in class okhttp3.slack.SlackClient
-
Waits for an OAuth session for this client to be set.
- ca(int) - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
Set this certificate to be a certificate authority, with up to maxIntermediateCas
intermediate certificate authorities beneath it.
- 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
-
Sets the response cache to be used to read and write cached responses.
- cache() - Method in class okhttp3.OkHttpClient
-
- CacheAdapter - Class in okhttp3.internal.huc
-
- CacheAdapter(ResponseCache) - Constructor for class okhttp3.internal.huc.CacheAdapter
-
- 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.
- CacheInterceptor - Class in okhttp3.internal.cache
-
Serves requests from the cache and writes responses to the cache.
- CacheInterceptor(InternalCache) - Constructor for class okhttp3.internal.cache.CacheInterceptor
-
- CacheRequest - Interface in okhttp3.internal.cache
-
- cacheResponse - Variable in class okhttp3.internal.cache.CacheStrategy
-
The cached response to return or validate; or null if this call doesn't use a cache.
- CacheResponse - Class in okhttp3.recipes
-
- CacheResponse(File) - Constructor for class okhttp3.recipes.CacheResponse
-
- cacheResponse(Response) - Method in class okhttp3.Response.Builder
-
- cacheResponse() - Method in class okhttp3.Response
-
Returns the raw response received from the cache.
- CacheStrategy - Class in okhttp3.internal.cache
-
Given a request and cached response, this figures out whether to use the network, the cache, or
both.
- CacheStrategy.Factory - Class in okhttp3.internal.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
-
- calls - Variable in class okhttp3.RecordingHostnameVerifier
-
- CallServerInterceptor - Class in okhttp3.internal.http
-
This is the last interceptor in the chain.
- CallServerInterceptor(boolean) - Constructor for class okhttp3.internal.http.CallServerInterceptor
-
- callStackTrace - Variable in class okhttp3.internal.connection.StreamAllocation.StreamAllocationReference
-
Captures the stack trace at the time the Call is executed or enqueued.
- cancel() - Method in interface okhttp3.Call
-
Cancels the request, if possible.
- cancel() - Method in class okhttp3.internal.connection.RealConnection
-
- cancel() - Method in class okhttp3.internal.connection.StreamAllocation
-
- cancel() - Method in interface okhttp3.internal.http.HttpCodec
-
Cancel this stream.
- cancel() - Method in class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
Immediately closes the socket connection if it's currently held.
- cancel() - Method in class okhttp3.internal.http1.Http1Codec
-
- cancel() - Method in class okhttp3.internal.http2.Http2Codec
-
- CANCEL - Static variable in interface okhttp3.internal.http2.PushObserver
-
- cancel() - Method in class okhttp3.internal.ws.RealWebSocket
-
- cancel() - Method in interface okhttp3.WebSocket
-
Immediately and violently release resources held by this web socket, discarding any enqueued
messages.
- cancelAll() - Method in class okhttp3.Dispatcher
-
Cancel all calls currently enqueued or executing.
- CancelCall - Class in okhttp3.recipes
-
- CancelCall() - Constructor for class okhttp3.recipes.CancelCall
-
- certificate - Variable in class okhttp3.internal.tls.HeldCertificate
-
- certificateChain(HeldCertificate, HeldCertificate...) - Method in class okhttp3.internal.tls.SslClient.Builder
-
Configure the certificate chain to use when serving HTTPS responses.
- certificateChain(KeyPair, X509Certificate, X509Certificate...) - Method in class okhttp3.internal.tls.SslClient.Builder
-
- CertificateChainCleaner - Class in okhttp3.internal.tls
-
Computes the effective certificate chain from the raw array returned by Java's built in TLS APIs.
- CertificateChainCleaner() - Constructor for class okhttp3.internal.tls.CertificateChainCleaner
-
- 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.
- CertificatePinning - Class in okhttp3.recipes
-
- CertificatePinning() - Constructor for class okhttp3.recipes.CertificatePinning
-
- 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 either this media type
doesn't specify a charset, of it its charset is unsupported by the current runtime.
- 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
-
- CheckHandshake - Class in okhttp3.recipes
-
- CheckHandshake() - Constructor for class okhttp3.recipes.CheckHandshake
-
- checkOffsetAndCount(long, long, long) - Static method in class okhttp3.internal.Util
-
- checkURLPermitted(URL) - Method in interface okhttp3.internal.URLFilter
-
Deprecated.
Check whether request to the provided URL is permitted to be issued.
- CipherSuite - Class 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.
- clean(List<Certificate>, String) - Method in class okhttp3.internal.tls.BasicCertificateChainCleaner
-
Returns a cleaned chain for chain.
- clean(List<Certificate>, String) - Method in class okhttp3.internal.tls.CertificateChainCleaner
-
- clear(String) - Method in class okhttp3.FakeDns
-
Clears the results for hostname.
- clearHeaders() - Method in class okhttp3.mockwebserver.MockResponse
-
Removes all HTTP headers including any "Content-Length" and "Transfer-encoding" headers that
were added by default.
- CLEARTEXT - Static variable in class okhttp3.ConnectionSpec
-
Unencrypted, unauthenticated connections for http: URLs.
- client - Variable in class okhttp3.internal.connection.ConnectInterceptor
-
- client - Variable in class okhttp3.internal.ws.RealWebSocket.Streams
-
- client() - Method in class okhttp3.OkUrlFactory
-
Deprecated.
- clientId - Variable in class okhttp3.slack.SlackApi
-
- clientSecret - Variable in class okhttp3.slack.SlackApi
-
- clone() - Method in interface okhttp3.Call
-
Create a new, identical call to this one which can be enqueued or executed even if this call
has already been.
- clone() - Method in class okhttp3.mockwebserver.MockResponse
-
- clone() - Method in class okhttp3.OkUrlFactory
-
Deprecated.
Returns a copy of this stream handler factory that includes a shallow copy of the internal
HTTP client.
- close() - Method in class okhttp3.AndroidShimResponseCache
-
Uninstalls the cache and releases any active resources.
- close() - Method in class okhttp3.Cache
-
- close() - Method in class okhttp3.internal.cache.DiskLruCache
-
Closes this cache.
- close() - Method in class okhttp3.internal.cache.DiskLruCache.Snapshot
-
- close() - Method in class okhttp3.internal.http2.Http2Connection
-
Closes this connection.
- close(ErrorCode) - Method in class okhttp3.internal.http2.Http2Stream
-
Abnormally terminate this stream.
- close(int, String) - Method in class okhttp3.internal.ws.RealWebSocket
-
- close() - Method in class okhttp3.mockwebserver.MockWebServer
-
- close() - Method in class okhttp3.Response
-
Closes the response body.
- close() - Method in class okhttp3.ResponseBody
-
- close() - Method in class okhttp3.slack.OAuthSessionFactory
-
- close() - Method in class okhttp3.slack.RtmSession
-
- close(int, String) - Method in interface okhttp3.WebSocket
-
Attempts to initiate a graceful shutdown of this web socket.
- closeLater(ErrorCode) - Method in class okhttp3.internal.http2.Http2Stream
-
Abnormally terminate this stream.
- closeQuietly(Closeable) - Static method in class okhttp3.internal.Util
-
Closes closeable, ignoring any checked exceptions.
- closeQuietly(Socket) - Static method in class okhttp3.internal.Util
-
Closes socket, ignoring any checked exceptions.
- closeQuietly(ServerSocket) - Static method in class okhttp3.internal.Util
-
Closes serverSocket, ignoring any checked exceptions.
- code - Variable in class okhttp3.internal.http.StatusLine
-
- code(Response.Builder) - Method in class okhttp3.internal.Internal
-
- code(int) - Method in class okhttp3.Response.Builder
-
- code() - Method in class okhttp3.Response
-
Returns the HTTP status code.
- codec() - Method in class okhttp3.internal.connection.StreamAllocation
-
- commit() - Method in class okhttp3.internal.cache.DiskLruCache.Editor
-
Commits this edit so it is visible to readers.
- commonName(String) - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
Set this certificate's name.
- COMPATIBLE_TLS - Static variable in class okhttp3.ConnectionSpec
-
A backwards-compatible fallback connection for interop with obsolete servers.
- concat(String[], String) - Static method in class okhttp3.internal.Util
-
- configureSecureSocket(SSLSocket) - Method in class okhttp3.internal.connection.ConnectionSpecSelector
-
- ConfigureTimeouts - Class in okhttp3.recipes
-
- ConfigureTimeouts() - Constructor for class okhttp3.recipes.ConfigureTimeouts
-
- configureTlsExtensions(SSLSocket, String, List<Protocol>) - Method in class okhttp3.internal.platform.Platform
-
Configure TLS extensions on sslSocket for route.
- connect(int, int, int, boolean) - Method in class okhttp3.internal.connection.RealConnection
-
- connect() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- connect(OkHttpClient) - Method in class okhttp3.internal.ws.RealWebSocket
-
- connected(Route) - Method in class okhttp3.internal.connection.RouteDatabase
-
Records success connecting to route.
- connectFailed(URI, SocketAddress, IOException) - Method in class okhttp3.FakeProxySelector
-
- connectFailed(Route, IOException) - Method in class okhttp3.internal.connection.RouteSelector
-
Clients should invoke this method when they encounter a connectivity failure on a connection
returned by this route selector.
- ConnectInterceptor - Class in okhttp3.internal.connection
-
Opens a connection to the target server and proceeds to the next interceptor.
- ConnectInterceptor(OkHttpClient) - Constructor for class okhttp3.internal.connection.ConnectInterceptor
-
- Connection - Interface in okhttp3
-
The sockets and streams of an HTTP, HTTPS, or HTTPS+HTTP/2 connection.
- connection() - Method in interface okhttp3.Interceptor.Chain
-
Returns the connection the request will be executed on.
- connection() - Method in class okhttp3.internal.connection.StreamAllocation
-
- connection() - Method in class okhttp3.internal.http.RealInterceptorChain
-
- connectionBecameIdle(ConnectionPool, RealConnection) - Method in class okhttp3.internal.Internal
-
- connectionCount() - Method in class okhttp3.ConnectionPool
-
Returns total number of connections in the pool.
- connectionFailed(IOException) - Method in class okhttp3.internal.connection.ConnectionSpecSelector
-
Reports a failure to complete a connection.
- ConnectionPool - Class in okhttp3
-
Manages reuse of HTTP and HTTP/2 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
-
- ConnectionShutdownException - Exception in okhttp3.internal.http2
-
Thrown when an HTTP/2 connection is shutdown (either explicitly or if the peer has sent a GOAWAY
frame) and an attempt is made to use the connection.
- ConnectionShutdownException() - Constructor for exception okhttp3.internal.http2.ConnectionShutdownException
-
- 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
-
- ConnectionSpecSelector - Class in okhttp3.internal.connection
-
Handles the connection spec fallback strategy: When a secure socket connection fails due to a
handshake / protocol problem the connection may be retried with different protocols.
- ConnectionSpecSelector(List<ConnectionSpec>) - Constructor for class okhttp3.internal.connection.ConnectionSpecSelector
-
- connectSocket(Socket, InetSocketAddress, int) - Method in class okhttp3.internal.platform.Platform
-
- connectTimeout - Variable in class okhttp3.curl.Main
-
- 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(Response) - Static method in class okhttp3.internal.http.HttpHeaders
-
- contentLength(Headers) - Static method in class okhttp3.internal.http.HttpHeaders
-
- contentLength() - Method in class okhttp3.internal.http.RealResponseBody
-
- 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.internal.http.RealResponseBody
-
- 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
-
- Crawler - Class in okhttp3.sample
-
Fetches HTML from a requested URL, follows the links, and repeats.
- Crawler(OkHttpClient) - Constructor for class okhttp3.sample.Crawler
-
- create(File, long) - Static method in class okhttp3.AndroidShimResponseCache
-
- create(FileSystem, File, int, int, long) - Static method in class okhttp3.internal.cache.DiskLruCache
-
Create a cache which will reside in directory.
- 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
-
- createJavaCacheRequest(CacheRequest) - Static method in class okhttp3.internal.huc.JavaApiConverter
-
- createJavaCacheResponse(Response) - Static method in class okhttp3.internal.huc.JavaApiConverter
-
- createOkRequest(URI, String, Map<String, List<String>>) - Static method in class okhttp3.internal.huc.JavaApiConverter
-
Creates an OkHttp
Request from the supplied information.
- createOkResponseForCachePut(URI, URLConnection) - Static method in class okhttp3.internal.huc.JavaApiConverter
-
- createRequestBody(Request, long) - Method in interface okhttp3.internal.http.HttpCodec
-
Returns an output stream where the request body can be streamed.
- createRequestBody(Request, long) - Method in class okhttp3.internal.http1.Http1Codec
-
- createRequestBody(Request, long) - Method in class okhttp3.internal.http2.Http2Codec
-
- createURLStreamHandler(String) - Method in class okhttp3.OkUrlFactory
-
Deprecated.
- Credentials - Class in okhttp3
-
Factory for HTTP authorization credentials.
- CustomCipherSuites - Class in okhttp3.recipes
-
- CustomCipherSuites() - Constructor for class okhttp3.recipes.CustomCipherSuites
-
- CustomTrust - Class in okhttp3.recipes
-
- CustomTrust() - Constructor for class okhttp3.recipes.CustomTrust
-
- data - Variable in class okhttp3.curl.Main
-
- deduplicate(ConnectionPool, Address, StreamAllocation) - Method in class okhttp3.internal.Internal
-
- DEFAULT - Static variable in class okhttp3.CertificatePinner
-
- DEFAULT - Static variable in interface okhttp3.logging.HttpLoggingInterceptor.Logger
-
- defaultPort(String) - Static method in class okhttp3.HttpUrl
-
Returns 80 if scheme.equals("http"), 443 if scheme.equals("https") and -1
otherwise.
- delete() - Method in class okhttp3.AndroidShimResponseCache
-
Uninstalls the cache and deletes all of its stored contents.
- delete() - Method in class okhttp3.Cache
-
Closes the cache and deletes all of its stored values.
- delete() - Method in class okhttp3.internal.cache.DiskLruCache
-
Closes the cache and deletes all of its stored values.
- delete(File) - Method in interface okhttp3.internal.io.FileSystem
-
Deletes file if it exists.
- delete(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- delete(RequestBody) - Method in class okhttp3.Request.Builder
-
- delete() - Method in class okhttp3.Request.Builder
-
- deleteContents(File) - Method in interface okhttp3.internal.io.FileSystem
-
Recursively delete the contents of directory.
- deleteContents(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- delimiterOffset(String, int, int, String) - Static method in class okhttp3.internal.Util
-
Returns the index of the first character in input that contains a character in delimiters.
- delimiterOffset(String, int, int, char) - Static method in class okhttp3.internal.Util
-
Returns the index of the first character in input that is delimiter.
- DIGEST - Static variable in class okhttp3.MultipartBody
-
This type is syntactically identical to "multipart/mixed", but the semantics are different.
- directory() - Method in class okhttp3.Cache
-
- discard(Source, int, TimeUnit) - Static method in class okhttp3.internal.Util
-
Attempts to exhaust source, returning true if successful.
- DISCARD_STREAM_TIMEOUT_MILLIS - Static variable in interface okhttp3.internal.http.HttpCodec
-
The timeout to use while discarding a stream of input data.
- disconnect() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- DiskLruCache - Class in okhttp3.internal.cache
-
A cache that uses a bounded amount of space on a filesystem.
- DiskLruCache.Editor - Class in okhttp3.internal.cache
-
Edits the values for an entry.
- DiskLruCache.Snapshot - Class in okhttp3.internal.cache
-
A snapshot of the values for an entry.
- dispatch(RecordedRequest) - Method in class okhttp3.mockwebserver.Dispatcher
-
Returns a response to satisfy request.
- dispatch(RecordedRequest) - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- dispatch(RecordedRequest) - Method in class okhttp3.sample.SampleServer
-
- dispatch(RecordedRequest) - Method in class okhttp3.slack.OAuthSessionFactory
-
When the browser hits the redirect URL, use the provided code to ask Slack for a session.
- Dispatcher - Class in okhttp3
-
Policy on when async requests are executed.
- Dispatcher(ExecutorService) - Constructor for class okhttp3.Dispatcher
-
- Dispatcher() - Constructor for class okhttp3.Dispatcher
-
- Dispatcher - Class in okhttp3.mockwebserver
-
Handler for mock server requests.
- Dispatcher() - Constructor for class okhttp3.mockwebserver.Dispatcher
-
- dispatcher(Dispatcher) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the dispatcher used to set policy and execute asynchronous requests.
- dispatcher() - Method in class okhttp3.OkHttpClient
-
- dns() - Method in class okhttp3.Address
-
Returns the service that will be used to resolve IP addresses for hostnames.
- Dns - Interface in okhttp3
-
A domain name service that resolves IP addresses for host names.
- dns(Dns) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the DNS service used to lookup IP addresses for hostnames.
- dns() - Method in class okhttp3.OkHttpClient
-
- domain(String) - Method in class okhttp3.Cookie.Builder
-
Set the domain pattern for this cookie.
- domain() - Method in class okhttp3.Cookie
-
Returns the cookie's domain.
- domainToAscii(String) - Static method in class okhttp3.internal.Util
-
Performs IDN ToASCII encoding and canonicalize the result to lowercase.
- edit(String) - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns an editor for the entry named key, or null if another edit is in progress.
- edit() - Method in class okhttp3.internal.cache.DiskLruCache.Snapshot
-
Returns an editor for this snapshot's entry, or null if either the entry has changed since
this snapshot was created or if another edit is in progress.
- EMPTY_BYTE_ARRAY - Static variable in class okhttp3.internal.Util
-
- EMPTY_REQUEST - Static variable in class okhttp3.internal.Util
-
- EMPTY_RESPONSE - Static variable in class okhttp3.internal.Util
-
- EMPTY_STRING_ARRAY - Static variable in class okhttp3.internal.Util
-
- encodedFragment(String) - Method in class okhttp3.HttpUrl.Builder
-
- encodedFragment() - Method in class okhttp3.HttpUrl
-
Returns this URL's encoded fragment, like "abc" for http://host/#abc.
- encodedName(int) - Method in class okhttp3.FormBody
-
- encodedPassword(String) - Method in class okhttp3.HttpUrl.Builder
-
- encodedPassword() - Method in class okhttp3.HttpUrl
-
Returns the password, or an empty string if none is set.
- encodedPath(String) - Method in class okhttp3.HttpUrl.Builder
-
- encodedPath() - Method in class okhttp3.HttpUrl
-
Returns the entire path of this URL encoded for use in HTTP resource resolution.
- encodedPathSegments() - Method in class okhttp3.HttpUrl
-
Returns a list of encoded path segments like ["a", "b", "c"] for the URL http://host/a/b/c.
- encodedQuery(String) - Method in class okhttp3.HttpUrl.Builder
-
- encodedQuery() - Method in class okhttp3.HttpUrl
-
Returns the query of this URL, encoded for use in HTTP resource resolution.
- encodedUsername(String) - Method in class okhttp3.HttpUrl.Builder
-
- encodedUsername() - Method in class okhttp3.HttpUrl
-
Returns the username, or an empty string if none is set.
- encodedValue(int) - Method in class okhttp3.FormBody
-
- enqueue(Callback) - Method in interface okhttp3.Call
-
Schedules the request to be executed at some point in the future.
- enqueue(MockResponse) - Method in class okhttp3.mockwebserver.MockWebServer
-
Scripts response to be returned to a request made in sequence.
- enqueueRequestCookies(Cookie...) - Method in class okhttp3.RecordingCookieJar
-
- enqueueResponse(MockResponse) - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- ensureResourcesClosed() - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- equal(Object, Object) - Static method in class okhttp3.internal.Util
-
Returns true if two possibly-null objects are equal.
- equals(Object) - Method in class okhttp3.Address
-
- equals(Object) - Method in class okhttp3.CertificatePinner
-
- equals(Object) - Method in class okhttp3.Challenge
-
- equals(Object) - Method in class okhttp3.ConnectionSpec
-
- equals(Object) - Method in class okhttp3.Cookie
-
- equals(Object) - Method in class okhttp3.Handshake
-
- equals(Object) - Method in class okhttp3.Headers
-
Returns true if other is a Headers object with the same headers, with the same
casing, in the same order.
- equals(Object) - Method in class okhttp3.HttpUrl
-
- equals(Object) - Method in class okhttp3.internal.http2.Header
-
- equals(Object) - Method in class okhttp3.internal.tls.BasicCertificateChainCleaner
-
- equals(Object) - Method in class okhttp3.MediaType
-
- equals(Object) - Method in class okhttp3.Route
-
- equalsNonHost(Address, Address) - Method in class okhttp3.internal.Internal
-
- ErrorCode - Enum in okhttp3.internal.http2
-
- errorCode - Variable in exception okhttp3.internal.http2.StreamResetException
-
- evictAll() - Method in class okhttp3.Cache
-
Deletes all values stored in the cache.
- evictAll() - Method in class okhttp3.ConnectionPool
-
Close and remove all idle connections in the pool.
- evictAll() - Method in class okhttp3.internal.cache.DiskLruCache
-
Deletes all stored values from the cache.
- exchangeCode(String, HttpUrl) - Method in class okhttp3.slack.SlackApi
-
See https://api.slack.com/methods/oauth.access.
- execute(HttpUriRequest) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpUriRequest, HttpContext) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpHost, HttpRequest) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpHost, HttpRequest, HttpContext) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpUriRequest, ResponseHandler<? extends T>) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpUriRequest, ResponseHandler<? extends T>, HttpContext) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpHost, HttpRequest, ResponseHandler<? extends T>) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute(HttpHost, HttpRequest, ResponseHandler<? extends T>, HttpContext) - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- execute() - Method in interface okhttp3.Call
-
Invokes the request immediately, and blocks until the response can be processed or is in
error.
- execute() - Method in class okhttp3.internal.NamedRunnable
-
- executorService() - Method in class okhttp3.Dispatcher
-
- exists(File) - Method in interface okhttp3.internal.io.FileSystem
-
Returns true if file exists on the file system.
- exists(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- expiresAt(long) - Method in class okhttp3.Cookie.Builder
-
- expiresAt() - Method in class okhttp3.Cookie
-
- generateKeyPair() - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
- get(URI, String, Map<String, List<String>>) - Method in class okhttp3.AndroidShimResponseCache
-
- get(SSLSession) - Static method in class okhttp3.Handshake
-
- get(TlsVersion, CipherSuite, List<Certificate>, List<Certificate>) - Static method in class okhttp3.Handshake
-
- get(String) - Method in class okhttp3.Headers.Builder
-
Equivalent to build().get(name), but potentially faster.
- get(String) - Method in class okhttp3.Headers
-
Returns the last value corresponding to the specified field, or null.
- get(URL) - Static method in class okhttp3.HttpUrl
-
Returns an
HttpUrl for
url if its protocol is
http or
https, or
null if it has any other protocol.
- get(URI) - Static method in class okhttp3.HttpUrl
-
- get() - Method in class okhttp3.internal.cache.CacheStrategy.Factory
-
Returns a strategy to satisfy request using the a cached response response.
- get(String) - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns a snapshot of the entry named key, or null if it doesn't exist is not currently
readable.
- get(Request) - Method in interface okhttp3.internal.cache.InternalCache
-
- get(Request, Proxy.Type) - Static method in class okhttp3.internal.http.RequestLine
-
Returns the request status line, like "GET / HTTP/1.1".
- get(Response) - Static method in class okhttp3.internal.http.StatusLine
-
- get(Request) - Method in class okhttp3.internal.huc.CacheAdapter
-
- get(ConnectionPool, Address, StreamAllocation, Route) - Method in class okhttp3.internal.Internal
-
- get() - Static method in class okhttp3.internal.platform.Platform
-
- get() - Static method in class okhttp3.internal.publicsuffix.PublicSuffixDatabase
-
- get(X509TrustManager) - Static method in class okhttp3.internal.tls.CertificateChainCleaner
-
- get(X509Certificate...) - Static method in class okhttp3.internal.tls.CertificateChainCleaner
-
- get(X509TrustManager) - Static method in class okhttp3.internal.tls.TrustRootIndex
-
- get(X509Certificate...) - Static method in class okhttp3.internal.tls.TrustRootIndex
-
- get(String) - Static method in enum okhttp3.Protocol
-
Returns the protocol identified by protocol.
- get() - Method in class okhttp3.Request.Builder
-
- getApplicationBufferSize() - Method in class okhttp3.FakeSSLSession
-
- getBody() - Method in class okhttp3.mockwebserver.MockResponse
-
Returns a copy of the raw HTTP payload.
- getBody() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the body of this POST request.
- getBodyDelay(TimeUnit) - Method in class okhttp3.mockwebserver.MockResponse
-
- getBodySize() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the total size of the body of this POST request (before truncation).
- getCache() - Method in class okhttp3.AndroidShimResponseCache
-
- getCache() - Method in interface okhttp3.OkCacheContainer
-
- getChunkSizes() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the sizes of the chunks of this request's body, or an empty list if the request's body
was empty or unchunked.
- getCipherSuite() - Method in class okhttp3.FakeSSLSession
-
- getConnection() - Method in class okhttp3.internal.http2.Http2Stream
-
- getConnectionManager() - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- getConnectTimeout() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getCreationTime() - Method in class okhttp3.FakeSSLSession
-
- getDate(String) - Method in class okhttp3.Headers
-
Returns the last value corresponding to the specified field parsed as an HTTP date, or null if
either the field is absent or cannot be parsed as a date.
- getDelegate() - Method in class okhttp3.internal.huc.CacheAdapter
-
- getDirectory() - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns the directory where this cache stores its data.
- getEffectiveTldPlusOne(String) - Method in class okhttp3.internal.publicsuffix.PublicSuffixDatabase
-
Returns the effective top-level domain plus one (eTLD+1) by referencing the public suffix list.
- getErrorCode() - Method in class okhttp3.internal.http2.Http2Stream
-
Returns the reason why this stream was closed, or null if it closed normally or has not yet
been closed.
- getErrorStream() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
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.
- GetExample - Class in okhttp3.guide
-
- GetExample() - Constructor for class okhttp3.guide.GetExample
-
- getHeader(String) - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the first header named name, or null if no such header exists.
- getHeaderField(int) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
Returns the value of the field at position.
- getHeaderField(String) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
Returns the value of the field corresponding to the fieldName, or null if there is no
such field.
- getHeaderFieldKey(int) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getHeaderFields() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getHeaders() - Method in class okhttp3.mockwebserver.MockResponse
-
Returns the HTTP headers, such as "Content-Length: 0".
- getHeaders() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns all headers.
- getHitCount() - Method in class okhttp3.AndroidShimResponseCache
-
Returns the number of HTTP requests whose response was provided by the cache.
- getHostName() - Method in class okhttp3.mockwebserver.MockWebServer
-
- getHostnameVerifier() - Method in class okhttp3.internal.huc.OkHttpsURLConnection
-
- getHttp2ErrorCode() - Method in class okhttp3.mockwebserver.MockResponse
-
- getHttpUrlChecked(String) - Method in class okhttp3.internal.Internal
-
- getId() - Method in class okhttp3.FakeSSLSession
-
- getId() - Method in class okhttp3.internal.http2.Http2Stream
-
- getInputStream() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getInstanceFollowRedirects() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getLastAccessedTime() - Method in class okhttp3.FakeSSLSession
-
- getLastConnectException() - Method in exception okhttp3.internal.connection.RouteException
-
- getLength(int) - Method in class okhttp3.internal.cache.DiskLruCache.Snapshot
-
Returns the byte length of the value for index.
- getLevel() - Method in class okhttp3.logging.HttpLoggingInterceptor
-
- getLocalCertificates() - Method in class okhttp3.FakeSSLSession
-
- getLocalPrincipal() - Method in class okhttp3.FakeSSLSession
-
- getMaxRequests() - Method in class okhttp3.Dispatcher
-
- getMaxRequestsPerHost() - Method in class okhttp3.Dispatcher
-
- getMaxSize() - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns the maximum number of bytes that this cache should use to store its data.
- getMethod() - Method in class okhttp3.mockwebserver.RecordedRequest
-
- getNetworkCount() - Method in class okhttp3.AndroidShimResponseCache
-
Returns the number of HTTP requests that required the network to either supply a response or
validate a locally cached response.
- getOutputStream() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getPacketBufferSize() - Method in class okhttp3.FakeSSLSession
-
- getParams() - Method in class okhttp3.apache.OkApacheClient
-
Deprecated.
- getPath() - Method in class okhttp3.mockwebserver.RecordedRequest
-
- getPeerCertificateChain() - Method in class okhttp3.FakeSSLSession
-
- getPeerCertificates() - Method in class okhttp3.FakeSSLSession
-
- getPeerHost() - Method in class okhttp3.FakeSSLSession
-
- getPeerPort() - Method in class okhttp3.FakeSSLSession
-
- getPeerPrincipal() - Method in class okhttp3.FakeSSLSession
-
- getPermission() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getPort() - Method in class okhttp3.mockwebserver.MockWebServer
-
- getPrefix() - Method in class okhttp3.internal.platform.Platform
-
Prefix used on custom headers.
- getProtocol() - Method in class okhttp3.FakeSSLSession
-
- getProtocol() - Method in class okhttp3.internal.http2.Http2Connection
-
The protocol as selected using ALPN.
- getPushPromises() - Method in class okhttp3.mockwebserver.MockResponse
-
Returns the streams the server will push with this response.
- getReadTimeout() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getRequestCount() - Method in class okhttp3.AndroidShimResponseCache
-
Returns the total number of HTTP requests that were made.
- getRequestCount() - Method in class okhttp3.mockwebserver.MockWebServer
-
Returns the number of HTTP requests received thus far by this server.
- getRequestHeaders() - Method in class okhttp3.internal.http2.Http2Stream
-
- getRequestLine() - Method in class okhttp3.mockwebserver.RecordedRequest
-
- getRequestProperties() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getRequestProperty(String) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getRequestUrl() - Method in class okhttp3.mockwebserver.RecordedRequest
-
- getResponseCode() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getResponseMessage() - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- getSelectedProtocol(SSLSocket) - Method in class okhttp3.internal.platform.Platform
-
Returns the negotiated protocol, or null if no protocol was negotiated.
- getSequenceNumber() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the index of this request on its HTTP connection.
- getSessionContext() - Method in class okhttp3.FakeSSLSession
-
- getSettings() - Method in class okhttp3.mockwebserver.MockResponse
-
- getSink() - Method in class okhttp3.internal.http2.Http2Stream
-
Returns a sink that can be used to write data to the peer.
- getSocketPolicy() - Method in class okhttp3.mockwebserver.MockResponse
-
- getSource(int) - Method in class okhttp3.internal.cache.DiskLruCache.Snapshot
-
Returns the unbuffered stream with the value for index.
- getSource() - Method in class okhttp3.internal.http2.Http2Stream
-
Returns a source that reads data from the peer.
- getSSLSocketFactory() - Method in class okhttp3.internal.huc.OkHttpsURLConnection
-
- getStackTraceForCloseable(String) - Method in class okhttp3.internal.platform.Platform
-
Returns an object that holds a stack trace created at the moment this method is executed.
- getStatus() - Method in class okhttp3.mockwebserver.MockResponse
-
Returns the HTTP response line, such as "HTTP/1.1 200 OK".
- getThrottleBytesPerPeriod() - Method in class okhttp3.mockwebserver.MockResponse
-
- getThrottlePeriod(TimeUnit) - Method in class okhttp3.mockwebserver.MockResponse
-
- getTlsVersion() - Method in class okhttp3.mockwebserver.RecordedRequest
-
Returns the connection's TLS version or null if the connection doesn't use SSL.
- getUtf8Body() - Method in class okhttp3.mockwebserver.RecordedRequest
-
- getValue(String) - Method in class okhttp3.FakeSSLSession
-
- getValueNames() - Method in class okhttp3.FakeSSLSession
-
- getWebSocketListener() - Method in class okhttp3.mockwebserver.MockResponse
-
- GOOGLE_API_KEY - Static variable in class okhttp3.recipes.RequestBodyCompression
-
The Google API KEY for OkHttp recipes.
- 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() - Method in class okhttp3.internal.connection.RealConnection
-
- handshake() - Method in class okhttp3.internal.huc.OkHttpsURLConnection
-
- 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.
- hasBody(Response) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns true if the response must have a (possibly 0-length) body.
- hashCode() - Method in class okhttp3.Address
-
- hashCode() - Method in class okhttp3.CertificatePinner
-
- 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.Headers
-
- hashCode() - Method in class okhttp3.HttpUrl
-
- hashCode() - Method in class okhttp3.internal.http2.Header
-
- hashCode() - Method in class okhttp3.internal.tls.BasicCertificateChainCleaner
-
- hashCode() - Method in class okhttp3.MediaType
-
- hashCode() - Method in class okhttp3.Route
-
- hasMoreRoutes() - Method in class okhttp3.internal.connection.StreamAllocation
-
- hasNext() - Method in class okhttp3.internal.connection.RouteSelector
-
Returns true if there's another route to attempt.
- hasVaryAll(Response) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns true if a Vary header contains an asterisk.
- hasVaryAll(Headers) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns true if a Vary header contains an asterisk.
- head() - Method in class okhttp3.Request.Builder
-
- Header - Class in okhttp3.internal.http2
-
HTTP header: the name is an ASCII string, but the value can be UTF-8.
- Header(String, String) - Constructor for class okhttp3.internal.http2.Header
-
- Header(ByteString, String) - Constructor for class okhttp3.internal.http2.Header
-
- Header(ByteString, ByteString) - Constructor for class okhttp3.internal.http2.Header
-
- 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 - Variable in class okhttp3.curl.Main
-
- Headers - Class in okhttp3
-
The header fields of a single HTTP message.
- headers() - Method in class okhttp3.mockwebserver.PushPromise
-
- headers() - Method in class okhttp3.MultipartBody.Part
-
- 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
-
- HeldCertificate - Class in okhttp3.internal.tls
-
A certificate and its private key.
- HeldCertificate(X509Certificate, KeyPair) - Constructor for class okhttp3.internal.tls.HeldCertificate
-
- HeldCertificate.Builder - Class in okhttp3.internal.tls
-
- hitCount() - Method in class okhttp3.Cache
-
- host(String) - Method in class okhttp3.HttpUrl.Builder
-
- host() - Method in class okhttp3.HttpUrl
-
- hostHeader(HttpUrl, boolean) - Static method in class okhttp3.internal.Util
-
- 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.
- Http1Codec - Class in okhttp3.internal.http1
-
A socket connection that can be used to send HTTP/1.1 messages.
- Http1Codec(OkHttpClient, StreamAllocation, BufferedSource, BufferedSink) - Constructor for class okhttp3.internal.http1.Http1Codec
-
- Http2 - Class in okhttp3.internal.http2
-
- Http2Codec - Class in okhttp3.internal.http2
-
Encode requests and responses using HTTP/2 frames.
- Http2Codec(OkHttpClient, StreamAllocation, Http2Connection) - Constructor for class okhttp3.internal.http2.Http2Codec
-
- Http2Connection - Class in okhttp3.internal.http2
-
A socket connection to a remote peer.
- Http2Connection.Builder - Class in okhttp3.internal.http2
-
- Http2Connection.Listener - Class in okhttp3.internal.http2
-
Listener of streams and settings initiated by the peer.
- http2HeadersList(Request) - Static method in class okhttp3.internal.http2.Http2Codec
-
- Http2Server - Class in okhttp3.internal.http2
-
A basic HTTP/2 server that serves the contents of a local directory.
- Http2Server(File, SSLSocketFactory) - Constructor for class okhttp3.internal.http2.Http2Server
-
- Http2Stream - Class in okhttp3.internal.http2
-
A logical bidirectional stream.
- HTTP_CONTINUE - Static variable in class okhttp3.internal.http.StatusLine
-
- HTTP_PERM_REDIRECT - Static variable in class okhttp3.internal.http.StatusLine
-
- HTTP_TEMP_REDIRECT - Static variable in class okhttp3.internal.http.StatusLine
-
Numeric status code, 307: Temporary Redirect.
- httpCode - Variable in enum okhttp3.internal.http2.ErrorCode
-
- HttpCodec - Interface in okhttp3.internal.http
-
Encodes HTTP requests and decodes HTTP responses.
- HttpDate - Class in okhttp3.internal.http
-
Best-effort parser for HTTP dates.
- HttpHeaders - Class in okhttp3.internal.http
-
Headers and utilities for internal use by OkHttp.
- HttpLoggingInterceptor - Class in okhttp3.logging
-
An OkHttp interceptor which logs request and response information.
- HttpLoggingInterceptor() - Constructor for class okhttp3.logging.HttpLoggingInterceptor
-
- HttpLoggingInterceptor(HttpLoggingInterceptor.Logger) - Constructor for class okhttp3.logging.HttpLoggingInterceptor
-
- HttpLoggingInterceptor.Level - Enum in okhttp3.logging
-
- HttpLoggingInterceptor.Logger - Interface in okhttp3.logging
-
- HttpMethod - Class in okhttp3.internal.http
-
- 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.
- httpStream() - Method in class okhttp3.internal.http.RealInterceptorChain
-
- HttpUrl - Class in okhttp3
-
A uniform resource locator (URL) with a scheme of either http or https.
- HttpUrl.Builder - Class in okhttp3
-
- idleAtNanos - Variable in class okhttp3.internal.connection.RealConnection
-
Nanotime timestamp when allocations.size() reached zero.
- idleConnectionCount() - Method in class okhttp3.ConnectionPool
-
Returns the number of idle connections in the pool.
- immutable() - Method in class okhttp3.CacheControl.Builder
-
- immutable() - Method in class okhttp3.CacheControl
-
- immutableList(List<T>) - Static method in class okhttp3.internal.Util
-
Returns an immutable copy of list.
- immutableList(T...) - Static method in class okhttp3.internal.Util
-
Returns an immutable list containing elements.
- indexOf(Comparator<String>, String[], String) - Static method in class okhttp3.internal.Util
-
- indexOfControlOrNonAscii(String) - Static method in class okhttp3.internal.Util
-
Returns the index of the first character in input that is either a control character
(like or \n) or a non-ASCII character.
- INFO - Static variable in class okhttp3.internal.platform.Platform
-
- initialize() - Method in class okhttp3.Cache
-
Initialize the cache.
- initialize() - Method in class okhttp3.internal.cache.DiskLruCache
-
- initializeInstanceForTests() - Static method in class okhttp3.internal.Internal
-
- initOauthSession(OAuthSession) - Method in class okhttp3.slack.SlackClient
-
Set the OAuth session for this client.
- initReaderAndWriter(String, long, RealWebSocket.Streams) - Method in class okhttp3.internal.ws.RealWebSocket
-
- InMemoryFileSystem - Class in okhttp3.internal.io
-
A simple file system where all files are held in memory.
- InMemoryFileSystem() - Constructor for class okhttp3.internal.io.InMemoryFileSystem
-
- InstallUncaughtExceptionHandlerListener - Class in okhttp3.testing
-
- InstallUncaughtExceptionHandlerListener() - Constructor for class okhttp3.testing.InstallUncaughtExceptionHandlerListener
-
- instance - Static variable in class okhttp3.internal.Internal
-
- INSTANCE - Static variable in class okhttp3.internal.tls.OkHostnameVerifier
-
- intercept(Interceptor.Chain) - Method in interface okhttp3.Interceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.internal.cache.CacheInterceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.internal.connection.ConnectInterceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.internal.http.BridgeInterceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.internal.http.CallServerInterceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
- intercept(Interceptor.Chain) - Method in class okhttp3.logging.HttpLoggingInterceptor
-
- Interceptor - Interface in okhttp3
-
Observes, modifies, and potentially short-circuits requests going out and the corresponding
responses 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).
- Internal - Class in okhttp3.internal
-
Escalate internal APIs in okhttp3 so they can be used from OkHttp's implementation
packages.
- Internal() - Constructor for class okhttp3.internal.Internal
-
- InternalCache - Interface in okhttp3.internal.cache
-
OkHttp's internal cache interface.
- intersect(Comparator<? super String>, String[], String[]) - Static method in class okhttp3.internal.Util
-
Returns an array containing only elements found in first and also in second.
- invalidate() - Method in class okhttp3.FakeSSLSession
-
- invalidatesCache(String) - Static method in class okhttp3.internal.http.HttpMethod
-
- isAndroidGetsocknameError(AssertionError) - Static method in class okhttp3.internal.Util
-
Returns true if e is due to a firmware bug fixed after Android 4.2.2.
- isCacheable(Response, Request) - Static method in class okhttp3.internal.cache.CacheStrategy
-
Returns true if response can be stored to later serve another request.
- isCanceled() - Method in interface okhttp3.Call
-
- isCanceled() - Method in class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
- isCleartextTrafficPermitted(String) - Method in class okhttp3.internal.platform.Platform
-
- isClosed() - Method in class okhttp3.Cache
-
- isClosed() - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns true if this cache has been closed.
- isClosed() - Method in class okhttp3.internal.http1.Http1Codec
-
Returns true if this connection is closed.
- isCompatible(SSLSocket) - Method in class okhttp3.ConnectionSpec
-
Returns true if the socket, as currently configured, supports this connection spec.
- isEligible(Address, Route) - Method in class okhttp3.internal.connection.RealConnection
-
Returns true if this connection can carry a stream allocation to address.
- isEquivalent(File, long) - Method in class okhttp3.AndroidShimResponseCache
-
- isExecuted() - Method in interface okhttp3.Call
-
- isHealthy(boolean) - Method in class okhttp3.internal.connection.RealConnection
-
Returns true if this connection is ready to host new streams.
- isHttps() - Method in class okhttp3.HttpUrl
-
- isHttps() - Method in class okhttp3.Request
-
- isLocallyInitiated() - Method in class okhttp3.internal.http2.Http2Stream
-
Returns true if this stream was created by this peer.
- isMultiplexed() - Method in class okhttp3.internal.connection.RealConnection
-
Returns true if this is an HTTP/2 connection.
- isOpen() - Method in class okhttp3.internal.http2.Http2Stream
-
Returns true if this stream is open.
- 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.
- isShutdown() - Method in class okhttp3.internal.http2.Http2Connection
-
- 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.
- issuedBy(HeldCertificate) - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
Set the certificate that signs this certificate.
- isTls() - Method in class okhttp3.ConnectionSpec
-
- isValid() - Method in class okhttp3.FakeSSLSession
-
- 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.
- name - Variable in class okhttp3.internal.http2.Header
-
Name in case-insensitive ASCII encoding.
- name - Variable in class okhttp3.internal.NamedRunnable
-
- NamedRunnable - Class in okhttp3.internal
-
Runnable implementation which always sets its thread name.
- NamedRunnable(String, Object...) - Constructor for class okhttp3.internal.NamedRunnable
-
- names() - Method in class okhttp3.Headers
-
Returns an immutable case-insensitive set of header names.
- NATURAL_ORDER - Static variable in class okhttp3.internal.Util
-
- 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.
- networkRequest - Variable in class okhttp3.internal.cache.CacheStrategy
-
The request to send on the network, or null if this call doesn't use the network.
- networkResponse(Response) - Method in class okhttp3.Response.Builder
-
- networkResponse() - Method in class okhttp3.Response
-
Returns the raw response received from the network.
- newAuthorizeUrl(String, String, OAuthSessionFactory.Listener) - Method in class okhttp3.slack.OAuthSessionFactory
-
- 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.
- newChunkedSink() - Method in class okhttp3.internal.http1.Http1Codec
-
- newChunkedSource(HttpUrl) - Method in class okhttp3.internal.http1.Http1Codec
-
- newCodec(OkHttpClient, StreamAllocation) - Method in class okhttp3.internal.connection.RealConnection
-
- newFixedLengthSink(long) - Method in class okhttp3.internal.http1.Http1Codec
-
- newFixedLengthSource(long) - Method in class okhttp3.internal.http1.Http1Codec
-
- newSink(int) - Method in class okhttp3.internal.cache.DiskLruCache.Editor
-
Returns a new unbuffered output stream to write the value at index.
- newSource(int) - Method in class okhttp3.internal.cache.DiskLruCache.Editor
-
Returns an unbuffered input stream to read the last committed value, or null if no value has
been committed.
- newStream(OkHttpClient, boolean) - Method in class okhttp3.internal.connection.StreamAllocation
-
- newStream(List<Header>, boolean) - Method in class okhttp3.internal.http2.Http2Connection
-
Returns a new locally-initiated stream.
- newUnknownLengthSource() - Method in class okhttp3.internal.http1.Http1Codec
-
- newWebSocket(Request, WebSocketListener) - Method in class okhttp3.OkHttpClient
-
Uses request to connect a new web socket.
- newWebSocket(Request, WebSocketListener) - Method in interface okhttp3.WebSocket.Factory
-
- newWebSocketCall(OkHttpClient, Request) - Method in class okhttp3.internal.Internal
-
- newWebSocketStreams(StreamAllocation) - Method in class okhttp3.internal.connection.RealConnection
-
- next() - Method in class okhttp3.internal.connection.RouteSelector
-
- 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.
- nonEmptyIntersection(Comparator<String>, String[], String[]) - Static method in class okhttp3.internal.Util
-
Returns true if there is an element in first that is also in second.
- noNewStreams - Variable in class okhttp3.internal.connection.RealConnection
-
If true, no new streams can be created on this connection.
- noNewStreams() - Method in class okhttp3.internal.connection.StreamAllocation
-
Forbid new streams from being created on the connection that hosts this allocation.
- 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
-
- OAuthSession - Class in okhttp3.slack
-
Authorization for an application to make Slack API calls on behalf of a user.
- OAuthSession(boolean, String, String, String, String, String) - Constructor for class okhttp3.slack.OAuthSession
-
- OAuthSessionFactory - Class in okhttp3.slack
-
Runs a MockWebServer on localhost and uses it as the backend to receive an OAuth session.
- OAuthSessionFactory(SlackApi) - Constructor for class okhttp3.slack.OAuthSessionFactory
-
- OAuthSessionFactory.Listener - Interface in okhttp3.slack
-
- of(String...) - Static method in class okhttp3.Headers
-
Returns headers for the alternating header names and values.
- of(Map<String, String>) - Static method in class okhttp3.Headers
-
Returns headers for the header names and values in the
Map.
- ok - Variable in class okhttp3.slack.OAuthSession
-
- OkApacheClient - Class in okhttp3.apache
-
- OkApacheClient() - Constructor for class okhttp3.apache.OkApacheClient
-
Deprecated.
- OkApacheClient(OkHttpClient) - Constructor for class okhttp3.apache.OkApacheClient
-
Deprecated.
- OkCacheContainer - Interface in okhttp3
-
- OkHostnameVerifier - Class in okhttp3.internal.tls
-
A HostnameVerifier consistent with
RFC 2818.
- okhttp3 - package okhttp3
-
An HTTP+HTTP/2 client for Android and Java applications.
- okhttp3.apache - package okhttp3.apache
-
- okhttp3.benchmarks - package okhttp3.benchmarks
-
- okhttp3.curl - package okhttp3.curl
-
- okhttp3.guide - package okhttp3.guide
-
- okhttp3.internal - package okhttp3.internal
-
- okhttp3.internal.cache - package okhttp3.internal.cache
-
- okhttp3.internal.cache2 - package okhttp3.internal.cache2
-
- okhttp3.internal.connection - package okhttp3.internal.connection
-
- okhttp3.internal.http - package okhttp3.internal.http
-
- okhttp3.internal.http1 - package okhttp3.internal.http1
-
- okhttp3.internal.http2 - package okhttp3.internal.http2
-
- okhttp3.internal.huc - package okhttp3.internal.huc
-
- okhttp3.internal.io - package okhttp3.internal.io
-
- okhttp3.internal.platform - package okhttp3.internal.platform
-
- okhttp3.internal.publicsuffix - package okhttp3.internal.publicsuffix
-
- okhttp3.internal.tls - package okhttp3.internal.tls
-
- okhttp3.internal.ws - package okhttp3.internal.ws
-
- okhttp3.logging - package okhttp3.logging
-
An OkHttp interceptor which logs HTTP request and response data.
- okhttp3.mockwebserver - package okhttp3.mockwebserver
-
- okhttp3.recipes - package okhttp3.recipes
-
- okhttp3.sample - package okhttp3.sample
-
- okhttp3.slack - package okhttp3.slack
-
- okhttp3.testing - package okhttp3.testing
-
- OkHttpClient - Class in okhttp3
-
Factory for
calls, which can be used to send HTTP requests and read their
responses.
- OkHttpClient() - Constructor for class okhttp3.OkHttpClient
-
- OkHttpClient.Builder - Class in okhttp3
-
- OkHttpContributors - Class in okhttp3.sample
-
- OkHttpsURLConnection - Class in okhttp3.internal.huc
-
- OkHttpsURLConnection(URL, OkHttpClient) - Constructor for class okhttp3.internal.huc.OkHttpsURLConnection
-
- OkHttpsURLConnection(URL, OkHttpClient, URLFilter) - Constructor for class okhttp3.internal.huc.OkHttpsURLConnection
-
- OkHttpsURLConnection(OkHttpURLConnection) - Constructor for class okhttp3.internal.huc.OkHttpsURLConnection
-
- OkHttpURLConnection - Class in okhttp3.internal.huc
-
This implementation uses
Call to send requests and receive responses.
- OkHttpURLConnection(URL, OkHttpClient) - Constructor for class okhttp3.internal.huc.OkHttpURLConnection
-
- OkHttpURLConnection(URL, OkHttpClient, URLFilter) - Constructor for class okhttp3.internal.huc.OkHttpURLConnection
-
- OkUrlFactory - Class in okhttp3
-
- OkUrlFactory(OkHttpClient) - Constructor for class okhttp3.OkUrlFactory
-
Deprecated.
- onClosed(WebSocket, int, String) - Method in class okhttp3.WebSocketListener
-
Invoked when both peers have indicated that no more messages will be transmitted and the
connection has been successfully released.
- onClosing(WebSocket, int, String) - Method in class okhttp3.recipes.WebSocketEcho
-
- onClosing(WebSocket, int, String) - Method in class okhttp3.slack.RtmSession
-
- onClosing(WebSocket, int, String) - Method in class okhttp3.WebSocketListener
-
Invoked when the peer has indicated that no more incoming messages will be transmitted.
- onData(int, BufferedSource, int, boolean) - Method in interface okhttp3.internal.http2.PushObserver
-
A chunk of response data corresponding to a pushed request.
- onFailure(Call, IOException) - Method in interface okhttp3.Callback
-
Called when the request could not be executed due to cancellation, a connectivity problem or
timeout.
- onFailure(Call, IOException) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- onFailure(WebSocket, Throwable, Response) - Method in class okhttp3.recipes.WebSocketEcho
-
- onFailure(WebSocket, Throwable, Response) - Method in class okhttp3.slack.RtmSession
-
- onFailure(WebSocket, Throwable, Response) - Method in class okhttp3.WebSocketListener
-
Invoked when a web socket has been closed due to an error reading from or writing to the
network.
- onHeaders(int, List<Header>, boolean) - Method in interface okhttp3.internal.http2.PushObserver
-
The response headers corresponding to a pushed request.
- onlyIfCached() - Method in class okhttp3.CacheControl.Builder
-
Only accept the response if it is in the cache.
- onlyIfCached() - Method in class okhttp3.CacheControl
-
This field's name "only-if-cached" is misleading.
- onMessage(WebSocket, String) - Method in class okhttp3.recipes.WebSocketEcho
-
- onMessage(WebSocket, ByteString) - Method in class okhttp3.recipes.WebSocketEcho
-
- onMessage(WebSocket, String) - Method in class okhttp3.slack.RtmSession
-
- onMessage(WebSocket, String) - Method in class okhttp3.WebSocketListener
-
Invoked when a text (type 0x1) message has been received.
- onMessage(WebSocket, ByteString) - Method in class okhttp3.WebSocketListener
-
Invoked when a binary (type 0x2) message has been received.
- onOpen(WebSocket, Response) - Method in class okhttp3.recipes.WebSocketEcho
-
- onOpen(WebSocket, Response) - Method in class okhttp3.slack.RtmSession
-
- onOpen(WebSocket, Response) - Method in class okhttp3.WebSocketListener
-
Invoked when a web socket has been accepted by the remote peer and may begin transmitting
messages.
- onReadClose(int, String) - Method in class okhttp3.internal.ws.RealWebSocket
-
- onReadMessage(String) - Method in class okhttp3.internal.ws.RealWebSocket
-
- onReadMessage(ByteString) - Method in class okhttp3.internal.ws.RealWebSocket
-
- onReadPing(ByteString) - Method in class okhttp3.internal.ws.RealWebSocket
-
- onReadPong(ByteString) - Method in class okhttp3.internal.ws.RealWebSocket
-
- onRequest(int, List<Header>) - Method in interface okhttp3.internal.http2.PushObserver
-
Describes the request that the server intends to push a response for.
- onReset(int, ErrorCode) - Method in interface okhttp3.internal.http2.PushObserver
-
Indicates the reason why this stream was canceled.
- onResponse(Call, Response) - Method in interface okhttp3.Callback
-
Called when the HTTP response was successfully returned by the remote server.
- onResponse(Call, Response) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- onSettings(Http2Connection) - Method in class okhttp3.internal.connection.RealConnection
-
When settings are received, adjust the allocation limit.
- onSettings(Http2Connection) - Method in class okhttp3.internal.http2.Http2Connection.Listener
-
Notification that the connection's peer's settings may have changed.
- onStream(Http2Stream) - Method in class okhttp3.internal.connection.RealConnection
-
Refuse incoming streams.
- onStream(Http2Stream) - Method in class okhttp3.internal.http2.Http2Connection.Listener
-
Handle a new stream from this connection's peer.
- onStream(Http2Stream) - Method in class okhttp3.internal.http2.Http2Server
-
- open(URL) - Method in class okhttp3.OkUrlFactory
-
Deprecated.
- open(String) - Method in class okhttp3.slack.RtmSession
-
- openResponseBody(Response) - Method in interface okhttp3.internal.http.HttpCodec
-
Returns a stream that reads the response body.
- openResponseBody(Response) - Method in class okhttp3.internal.http1.Http1Codec
-
- openResponseBody(Response) - Method in class okhttp3.internal.http2.Http2Codec
-
- openStreamCount() - Method in class okhttp3.internal.http2.Http2Connection
-
- 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.internal.http.HttpDate
-
Returns the date for value.
- parse(String) - Static method in class okhttp3.internal.http.StatusLine
-
- 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.
- parseChallenges(Headers, String) - Static method in class okhttp3.internal.http.HttpHeaders
-
Parse RFC 2617 challenges, also wrong ordered ones.
- ParseResponseWithMoshi - Class in okhttp3.recipes
-
- ParseResponseWithMoshi() - Constructor for class okhttp3.recipes.ParseResponseWithMoshi
-
- parseSeconds(String, int) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns value as a positive integer, or 0 if it is negative, or defaultValue if
it cannot be parsed.
- 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.
- path() - Method in class okhttp3.mockwebserver.PushPromise
-
- pathSegments() - Method in class okhttp3.HttpUrl
-
Returns a list of path segments like ["a", "b", "c"] for the URL http://host/a/b/c.
- pathSize() - Method in class okhttp3.HttpUrl
-
Returns the number of segments in this URL's path.
- peek() - Method in class okhttp3.mockwebserver.Dispatcher
-
Returns an early guess of the next response, used for policy on how an incoming request should
be received.
- peek() - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- 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.
- PerCallSettings - Class in okhttp3.recipes
-
- PerCallSettings() - Constructor for class okhttp3.recipes.PerCallSettings
-
- permitsRequestBody(String) - Static method in class okhttp3.internal.http.HttpMethod
-
- persistent() - Method in class okhttp3.Cookie
-
Returns true if this cookie does not expire at the end of the current session.
- pin(Certificate) - Static method in class okhttp3.CertificatePinner
-
Returns the SHA-256 of certificate's public key.
- ping() - Method in class okhttp3.internal.http2.Http2Connection
-
Sends a ping frame to the peer.
- pingInterval(long, TimeUnit) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the interval between web socket pings initiated by this client.
- pingIntervalMillis() - Method in class okhttp3.OkHttpClient
-
Web socket ping interval (in milliseconds).
- Platform - Class in okhttp3.internal.platform
-
Access to platform-specific features.
- Platform() - Constructor for class okhttp3.internal.platform.Platform
-
- 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.
- port - Variable in class okhttp3.slack.SlackApi
-
- post(RequestBody) - Method in class okhttp3.Request.Builder
-
- PostExample - Class in okhttp3.guide
-
- PostExample() - Constructor for class okhttp3.guide.PostExample
-
- PostFile - Class in okhttp3.recipes
-
- PostFile() - Constructor for class okhttp3.recipes.PostFile
-
- PostForm - Class in okhttp3.recipes
-
- PostForm() - Constructor for class okhttp3.recipes.PostForm
-
- PostMultipart - Class in okhttp3.recipes
-
- PostMultipart() - Constructor for class okhttp3.recipes.PostMultipart
-
- PostStreaming - Class in okhttp3.recipes
-
- PostStreaming() - Constructor for class okhttp3.recipes.PostStreaming
-
- PostStreamingWithPipe - Class in okhttp3.recipes
-
- PostStreamingWithPipe() - Constructor for class okhttp3.recipes.PostStreamingWithPipe
-
- PostString - Class in okhttp3.recipes
-
- PostString() - Constructor for class okhttp3.recipes.PostString
-
- 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
-
- proceed(Request) - Method in class okhttp3.internal.http.RealInterceptorChain
-
- proceed(Request, StreamAllocation, HttpCodec, RealConnection) - Method in class okhttp3.internal.http.RealInterceptorChain
-
- Progress - Class in okhttp3.recipes
-
- Progress() - Constructor for class okhttp3.recipes.Progress
-
- 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() - Method in class okhttp3.internal.connection.RealConnection
-
- protocol - Variable in class okhttp3.internal.http.StatusLine
-
- 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
-
- proxies - Variable in class okhttp3.FakeProxySelector
-
- 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
-
- PSEUDO_PREFIX - Static variable in class okhttp3.internal.http2.Header
-
- PUBLIC_SUFFIX_RESOURCE - Static variable in class okhttp3.internal.publicsuffix.PublicSuffixDatabase
-
- PublicSuffixDatabase - Class in okhttp3.internal.publicsuffix
-
- PublicSuffixDatabase() - Constructor for class okhttp3.internal.publicsuffix.PublicSuffixDatabase
-
- pushObserver(PushObserver) - Method in class okhttp3.internal.http2.Http2Connection.Builder
-
- PushObserver - Interface in okhttp3.internal.http2
-
- PushPromise - Class in okhttp3.mockwebserver
-
An HTTP request initiated by the server.
- PushPromise(String, String, Headers, MockResponse) - Constructor for class okhttp3.mockwebserver.PushPromise
-
- pushStream(int, List<Header>, boolean) - Method in class okhttp3.internal.http2.Http2Connection
-
Returns a new server-initiated stream.
- put(URI, URLConnection) - Method in class okhttp3.AndroidShimResponseCache
-
- put(Response) - Method in interface okhttp3.internal.cache.InternalCache
-
- put(Response) - Method in class okhttp3.internal.huc.CacheAdapter
-
- put(ConnectionPool, RealConnection) - Method in class okhttp3.internal.Internal
-
- put(RequestBody) - Method in class okhttp3.Request.Builder
-
- putValue(String, Object) - Method in class okhttp3.FakeSSLSession
-
- readHeaders() - Method in class okhttp3.internal.http1.Http1Codec
-
Reads headers or trailers.
- readHttp2HeadersList(List<Header>) - Static method in class okhttp3.internal.http2.Http2Codec
-
Returns headers for a name value block containing an HTTP/2 response.
- readResponseHeaders(boolean) - Method in interface okhttp3.internal.http.HttpCodec
-
Parses bytes of a response header from an HTTP transport.
- readResponseHeaders(boolean) - Method in class okhttp3.internal.http1.Http1Codec
-
- readResponseHeaders(boolean) - Method in class okhttp3.internal.http2.Http2Codec
-
- readTimeout - Variable in class okhttp3.curl.Main
-
- readTimeout() - Method in class okhttp3.internal.http2.Http2Stream
-
- readTimeout(long, TimeUnit) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the default read timeout for new connections.
- readTimeoutMillis() - Method in class okhttp3.OkHttpClient
-
Default read timeout (in milliseconds).
- RealConnection - Class in okhttp3.internal.connection
-
- RealConnection(ConnectionPool, Route) - Constructor for class okhttp3.internal.connection.RealConnection
-
- RealInterceptorChain - Class in okhttp3.internal.http
-
A concrete interceptor chain that carries the entire interceptor chain: all application
interceptors, the OkHttp core, all network interceptors, and finally the network caller.
- RealInterceptorChain(List<Interceptor>, StreamAllocation, HttpCodec, RealConnection, int, Request) - Constructor for class okhttp3.internal.http.RealInterceptorChain
-
- realm() - Method in class okhttp3.Challenge
-
Returns the protection space.
- RealResponseBody - Class in okhttp3.internal.http
-
- RealResponseBody(Headers, BufferedSource) - Constructor for class okhttp3.internal.http.RealResponseBody
-
- RealWebSocket - Class in okhttp3.internal.ws
-
- RealWebSocket(Request, WebSocketListener, Random) - Constructor for class okhttp3.internal.ws.RealWebSocket
-
- RealWebSocket.Streams - Class in okhttp3.internal.ws
-
- receivedResponseAtMillis(long) - Method in class okhttp3.Response.Builder
-
- receivedResponseAtMillis() - Method in class okhttp3.Response
-
Returns a
timestamp taken immediately after OkHttp
received this response's headers from the network.
- receiveHeaders(CookieJar, HttpUrl, Headers) - Static method in class okhttp3.internal.http.HttpHeaders
-
- RecordedRequest - Class in okhttp3.mockwebserver
-
An HTTP request that came into the mock web server.
- RecordedRequest(String, Headers, List<Integer>, long, Buffer, int, Socket) - Constructor for class okhttp3.mockwebserver.RecordedRequest
-
- RecordingCookieJar - Class in okhttp3
-
- RecordingCookieJar() - Constructor for class okhttp3.RecordingCookieJar
-
- RecordingHostnameVerifier - Class in okhttp3
-
- RecordingHostnameVerifier() - Constructor for class okhttp3.RecordingHostnameVerifier
-
- redact() - Method in class okhttp3.HttpUrl
-
Returns a string with containing this URL with its username, password, query, and fragment
stripped, and its path replaced with /....
- redirectsToGet(String) - Static method in class okhttp3.internal.http.HttpMethod
-
- redirectsWithBody(String) - Static method in class okhttp3.internal.http.HttpMethod
-
- referer - Variable in class okhttp3.curl.Main
-
- REFUSE_INCOMING_STREAMS - Static variable in class okhttp3.internal.http2.Http2Connection.Listener
-
- release() - Method in class okhttp3.internal.connection.StreamAllocation
-
- releaseAndAcquire(RealConnection) - Method in class okhttp3.internal.connection.StreamAllocation
-
Release the connection held by this connection and acquire newConnection instead.
- remove(String) - Method in class okhttp3.internal.cache.DiskLruCache
-
Drops the entry for key if it exists and can be removed.
- remove(Request) - Method in interface okhttp3.internal.cache.InternalCache
-
Remove any cache entries for the supplied request.
- remove(Request) - Method in class okhttp3.internal.huc.CacheAdapter
-
- removeAll(String) - Method in class okhttp3.Headers.Builder
-
- removeAllEncodedQueryParameters(String) - Method in class okhttp3.HttpUrl.Builder
-
- removeAllQueryParameters(String) - Method in class okhttp3.HttpUrl.Builder
-
- removeHeader(String) - Method in class okhttp3.mockwebserver.MockResponse
-
Removes all headers named name.
- removeHeader(String) - Method in class okhttp3.Request.Builder
-
- removeHeader(String) - Method in class okhttp3.Response.Builder
-
- removePathSegment(int) - Method in class okhttp3.HttpUrl.Builder
-
- removeValue(String) - Method in class okhttp3.FakeSSLSession
-
- rename(File, File) - Method in interface okhttp3.internal.io.FileSystem
-
Renames from to to.
- rename(File, File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- request() - Method in interface okhttp3.Call
-
Returns the original request that initiated this call.
- request() - Method in interface okhttp3.Interceptor.Chain
-
- request() - Method in class okhttp3.internal.http.RealInterceptorChain
-
- request() - Method in class okhttp3.internal.ws.RealWebSocket
-
- Request - Class in okhttp3
-
An HTTP request.
- request(Request) - Method in class okhttp3.Response.Builder
-
- request() - Method in class okhttp3.Response
-
The wire-level request that initiated this HTTP response.
- request() - Method in interface okhttp3.WebSocket
-
Returns the original request that initiated this web socket.
- Request.Builder - Class in okhttp3
-
- RequestBody - Class in okhttp3
-
- RequestBody() - Constructor for class okhttp3.RequestBody
-
- RequestBodyCompression - Class in okhttp3.recipes
-
- RequestBodyCompression() - Constructor for class okhttp3.recipes.RequestBodyCompression
-
- requestCount() - Method in class okhttp3.Cache
-
- RequestLine - Class in okhttp3.internal.http
-
- requestOauthSession(String, String) - Method in class okhttp3.slack.SlackClient
-
Shows a browser URL to authorize this app to act as this user.
- requestPath(HttpUrl) - Static method in class okhttp3.internal.http.RequestLine
-
Returns the path to request, like the '/' in 'GET / HTTP/1.1'.
- requiresRequestBody(String) - Static method in class okhttp3.internal.http.HttpMethod
-
- requiresTunnel() - Method in class okhttp3.Route
-
Returns true if this route tunnels HTTPS through an HTTP proxy.
- resolve(String) - Method in class okhttp3.HttpUrl
-
Returns the URL that would be retrieved by following link from this URL, or null if
the resulting URL is not well-formed.
- response() - Method in class okhttp3.mockwebserver.PushPromise
-
- Response - Class in okhttp3
-
An HTTP response.
- Response.Builder - Class in okhttp3
-
- RESPONSE_SOURCE - Static variable in class okhttp3.internal.huc.OkHttpURLConnection
-
Synthetic response header: the location from which the response was loaded.
- RESPONSE_STATUS - Static variable in class okhttp3.internal.http2.Header
-
- ResponseBody - Class in okhttp3
-
A one-shot stream from the origin server to the client application with the raw bytes of the
response body.
- ResponseBody() - Constructor for class okhttp3.ResponseBody
-
- responseQueue - Variable in class okhttp3.mockwebserver.QueueDispatcher
-
- RetryAndFollowUpInterceptor - Class in okhttp3.internal.http
-
This interceptor recovers from failures and follows redirects as necessary.
- RetryAndFollowUpInterceptor(OkHttpClient, boolean) - Constructor for class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
- retryOnConnectionFailure(boolean) - Method in class okhttp3.OkHttpClient.Builder
-
Configure this client to retry or not when a connectivity problem is encountered.
- retryOnConnectionFailure() - Method in class okhttp3.OkHttpClient
-
- RewriteResponseCacheControl - Class in okhttp3.recipes
-
- RewriteResponseCacheControl(File) - Constructor for class okhttp3.recipes.RewriteResponseCacheControl
-
- route() - Method in interface okhttp3.Connection
-
Returns the route used by this connection.
- route() - Method in class okhttp3.internal.connection.RealConnection
-
- Route - Class in okhttp3
-
The concrete route used by a connection to reach an abstract origin server.
- Route(Address, Proxy, InetSocketAddress) - Constructor for class okhttp3.Route
-
- RouteDatabase - Class in okhttp3.internal.connection
-
A blacklist of failed routes to avoid when creating a new connection to a target address.
- RouteDatabase() - Constructor for class okhttp3.internal.connection.RouteDatabase
-
- routeDatabase(ConnectionPool) - Method in class okhttp3.internal.Internal
-
- RouteException - Exception in okhttp3.internal.connection
-
An exception thrown to indicate a problem connecting via a single Route.
- RouteException(IOException) - Constructor for exception okhttp3.internal.connection.RouteException
-
- RouteSelector - Class in okhttp3.internal.connection
-
Selects routes to connect to an origin server.
- RouteSelector(Address, RouteDatabase) - Constructor for class okhttp3.internal.connection.RouteSelector
-
- rtm(HttpUrl, WebSocketListener) - Method in class okhttp3.slack.SlackApi
-
See https://api.slack.com/rtm.
- RtmSession - Class in okhttp3.slack
-
A realtime messaging session.
- RtmSession(SlackApi) - Constructor for class okhttp3.slack.RtmSession
-
- rtmStart(String) - Method in class okhttp3.slack.SlackApi
-
See https://api.slack.com/methods/rtm.start.
- RtmStartResponse - Class in okhttp3.slack
-
See https://api.slack.com/methods/rtm.start.
- RtmStartResponse() - Constructor for class okhttp3.slack.RtmStartResponse
-
- run() - Method in class okhttp3.AutobahnTester
-
- run() - Method in class okhttp3.benchmarks.Benchmark
-
- run() - Method in class okhttp3.curl.Main
-
- run() - Method in class okhttp3.internal.NamedRunnable
-
- run() - Method in class okhttp3.recipes.AccessHeaders
-
- run() - Method in class okhttp3.recipes.AsynchronousGet
-
- run() - Method in class okhttp3.recipes.Authenticate
-
- run() - Method in class okhttp3.recipes.CacheResponse
-
- run() - Method in class okhttp3.recipes.CancelCall
-
- run() - Method in class okhttp3.recipes.CertificatePinning
-
- run() - Method in class okhttp3.recipes.CheckHandshake
-
- run() - Method in class okhttp3.recipes.ConfigureTimeouts
-
- run() - Method in class okhttp3.recipes.CustomCipherSuites
-
- run() - Method in class okhttp3.recipes.CustomTrust
-
- run() - Method in class okhttp3.recipes.LoggingInterceptors
-
- run() - Method in class okhttp3.recipes.ParseResponseWithMoshi
-
- run() - Method in class okhttp3.recipes.PerCallSettings
-
- run() - Method in class okhttp3.recipes.PostFile
-
- run() - Method in class okhttp3.recipes.PostForm
-
- run() - Method in class okhttp3.recipes.PostMultipart
-
- run() - Method in class okhttp3.recipes.PostStreaming
-
- run() - Method in class okhttp3.recipes.PostStreamingWithPipe
-
- run() - Method in class okhttp3.recipes.PostString
-
- run() - Method in class okhttp3.recipes.Progress
-
- run() - Method in class okhttp3.recipes.RequestBodyCompression
-
- run() - Method in class okhttp3.recipes.RewriteResponseCacheControl
-
- run() - Method in class okhttp3.recipes.SynchronousGet
-
- run() - Method in class okhttp3.sample.SampleServer
-
- runningCalls() - Method in class okhttp3.Dispatcher
-
Returns a snapshot of the calls currently being executed.
- runningCallsCount() - Method in class okhttp3.Dispatcher
-
- SampleServer - Class in okhttp3.sample
-
- SampleServer(SSLContext, String, int) - Constructor for class okhttp3.sample.SampleServer
-
- saveFromResponse(HttpUrl, List<Cookie>) - Method in interface okhttp3.CookieJar
-
Saves cookies from an HTTP response to this store according to this jar's policy.
- saveFromResponse(HttpUrl, List<Cookie>) - Method in class okhttp3.JavaNetCookieJar
-
- saveFromResponse(HttpUrl, List<Cookie>) - Method in class okhttp3.RecordingCookieJar
-
- 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".
- scope - Variable in class okhttp3.slack.OAuthSession
-
- 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.
- select(URI) - Method in class okhttp3.FakeProxySelector
-
- SELECTED_PROTOCOL - Static variable in class okhttp3.internal.huc.OkHttpURLConnection
-
Synthetic response header: the selected
protocol ("spdy/3.1", "http/1.1",
etc).
- send(String) - Method in class okhttp3.internal.ws.RealWebSocket
-
- send(ByteString) - Method in class okhttp3.internal.ws.RealWebSocket
-
- send(String) - Method in interface okhttp3.WebSocket
-
Attempts to enqueue text to be UTF-8 encoded and sent as a the data of a text (type
0x1) message.
- send(ByteString) - Method in interface okhttp3.WebSocket
-
Attempts to enqueue bytes to be sent as a the data of a binary (type 0x2)
message.
- sendResponseHeaders(List<Header>, boolean) - Method in class okhttp3.internal.http2.Http2Stream
-
Sends a reply to an incoming stream.
- sentRequestAtMillis(long) - Method in class okhttp3.Response.Builder
-
- sentRequestAtMillis() - Method in class okhttp3.Response
-
Returns a
timestamp taken immediately before OkHttp
transmitted the initiating request over the network.
- serialNumber(String) - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
- sessionGranted(OAuthSession) - Method in interface okhttp3.slack.OAuthSessionFactory.Listener
-
- set(String, List<InetAddress>) - Method in class okhttp3.FakeDns
-
Sets the results for hostname.
- set(String, String) - Method in class okhttp3.Headers.Builder
-
Set a field with the specified value.
- setBody(Buffer) - Method in class okhttp3.mockwebserver.MockResponse
-
- setBody(String) - Method in class okhttp3.mockwebserver.MockResponse
-
Sets the response body to the UTF-8 encoded bytes of body.
- setBodyDelay(long, TimeUnit) - Method in class okhttp3.mockwebserver.MockResponse
-
Set the delayed time of the response body to delay.
- setBodyLimit(long) - Method in class okhttp3.mockwebserver.MockWebServer
-
Sets the number of bytes of the POST body to keep in memory to the given limit.
- setCache(OkHttpClient.Builder, InternalCache) - Method in class okhttp3.internal.Internal
-
- setCallStackTrace(Object) - Method in class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
- setChunkedBody(Buffer, int) - Method in class okhttp3.mockwebserver.MockResponse
-
Sets the response body to body, chunked every maxChunkSize bytes.
- setChunkedBody(String, int) - Method in class okhttp3.mockwebserver.MockResponse
-
Sets the response body to the UTF-8 encoded bytes of body, chunked every maxChunkSize bytes.
- setClient(OkHttpClient) - Method in class okhttp3.OkUrlFactory
-
Deprecated.
- setConnectTimeout(int) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setDispatcher(Dispatcher) - Method in class okhttp3.mockwebserver.MockWebServer
-
Sets the dispatcher used to match incoming requests to mock responses.
- setEncodedPathSegment(int, String) - Method in class okhttp3.HttpUrl.Builder
-
- setEncodedQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
- setFailFast(boolean) - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- setFailFast(MockResponse) - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- setFixedLengthStreamingMode(int) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setFixedLengthStreamingMode(long) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setHeader(String, Object) - Method in class okhttp3.mockwebserver.MockResponse
-
Removes all headers named name, then adds a new header with the name and value.
- setHeaders(Headers) - Method in class okhttp3.mockwebserver.MockResponse
-
Replaces all headers with those specified in headers.
- setHostnameVerifier(HostnameVerifier) - Method in class okhttp3.internal.huc.OkHttpsURLConnection
-
- setHttp2ErrorCode(int) - Method in class okhttp3.mockwebserver.MockResponse
-
- setIdleCallback(Runnable) - Method in class okhttp3.Dispatcher
-
Set a callback to be invoked each time the dispatcher becomes idle (when the number of running
calls returns to zero).
- setIfModifiedSince(long) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setInstanceFollowRedirects(boolean) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setLevel(HttpLoggingInterceptor.Level) - Method in class okhttp3.logging.HttpLoggingInterceptor
-
Change the level at which this interceptor logs.
- 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.
- setMaxSize(long) - Method in class okhttp3.internal.cache.DiskLruCache
-
Changes the maximum number of bytes the cache can store and queues a job to trim the existing
store, if necessary.
- setPathSegment(int, String) - Method in class okhttp3.HttpUrl.Builder
-
- setProtocolNegotiationEnabled(boolean) - Method in class okhttp3.mockwebserver.MockWebServer
-
Sets whether ALPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1
or HTTP/2.
- setProtocols(List<Protocol>) - Method in class okhttp3.mockwebserver.MockWebServer
-
Indicates the protocols supported by ALPN on incoming HTTPS connections.
- setQueryParameter(String, String) - Method in class okhttp3.HttpUrl.Builder
-
- setReadTimeout(int) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setRequestMethod(String) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setRequestProperty(String, String) - Method in class okhttp3.internal.huc.OkHttpURLConnection
-
- setResponseCache(OkUrlFactory, ResponseCache) - Static method in class okhttp3.AndroidInternal
-
Sets the response cache to be used to read and write cached responses.
- setResponseCode(int) - Method in class okhttp3.mockwebserver.MockResponse
-
- setServerSocketFactory(ServerSocketFactory) - Method in class okhttp3.mockwebserver.MockWebServer
-
- setSettings(Settings) - Method in class okhttp3.internal.http2.Http2Connection
-
Merges settings into this peer's settings and sends them to the remote peer.
- setSocketPolicy(SocketPolicy) - Method in class okhttp3.mockwebserver.MockResponse
-
- setSSLSocketFactory(SSLSocketFactory) - Method in class okhttp3.internal.huc.OkHttpsURLConnection
-
- setStatus(String) - Method in class okhttp3.mockwebserver.MockResponse
-
- Settings - Class in okhttp3.internal.http2
-
Settings describe characteristics of the sending peer, which are used by the receiving peer.
- Settings() - Constructor for class okhttp3.internal.http2.Settings
-
- setType(MediaType) - Method in class okhttp3.MultipartBody.Builder
-
Set the MIME type.
- shouldPostpone(Route) - Method in class okhttp3.internal.connection.RouteDatabase
-
Returns true if route has failed recently and should be avoided.
- showHeaders - Variable in class okhttp3.curl.Main
-
- showHttp2Frames - Variable in class okhttp3.curl.Main
-
- shutdown(ErrorCode) - Method in class okhttp3.internal.http2.Http2Connection
-
Degrades this connection such that new streams can neither be created locally, nor accepted
from the remote peer.
- shutdown() - Method in class okhttp3.mockwebserver.Dispatcher
-
Release any resources held by this dispatcher.
- shutdown() - Method in class okhttp3.mockwebserver.MockWebServer
-
- shutdown() - Method in class okhttp3.mockwebserver.QueueDispatcher
-
- sink(File) - Method in interface okhttp3.internal.io.FileSystem
-
Writes to file, discarding any data already present.
- sink(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- sink - Variable in class okhttp3.internal.ws.RealWebSocket.Streams
-
- size() - Method in class okhttp3.AndroidShimResponseCache
-
Returns the number of bytes currently being used to store the values in this cache.
- 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.internal.cache.DiskLruCache
-
Returns the number of bytes currently being used to store the values in this cache.
- size(File) - Method in interface okhttp3.internal.io.FileSystem
-
Returns the number of bytes stored in file, or 0 if it does not exist.
- size(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- size() - Method in class okhttp3.MultipartBody
-
The number of parts in this multipart body.
- skipAll(Source, int, TimeUnit) - Static method in class okhttp3.internal.Util
-
Reads until in is exhausted or the deadline has been reached.
- skipLeadingAsciiWhitespace(String, int, int) - Static method in class okhttp3.internal.Util
-
Increments pos until input[pos] is not ASCII whitespace.
- skipTrailingAsciiWhitespace(String, int, int) - Static method in class okhttp3.internal.Util
-
Decrements limit until input[limit - 1] is not ASCII whitespace.
- skipUntil(String, int, String) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns the next index in input at or after pos that contains a character from
characters.
- skipWhitespace(String, int) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns the next non-whitespace character in input that is white space.
- SlackApi - Class in okhttp3.slack
-
API access to the
Slack API as an application.
- SlackApi(String, String, int) - Constructor for class okhttp3.slack.SlackApi
-
- SlackClient - Class in okhttp3.slack
-
A connection to Slack as a single user.
- SlackClient(SlackApi) - Constructor for class okhttp3.slack.SlackClient
-
- sMaxAgeSeconds() - Method in class okhttp3.CacheControl
-
The "s-maxage" directive is the max age for shared caches.
- snapshots() - Method in class okhttp3.internal.cache.DiskLruCache
-
Returns an iterator over the cache's current entries.
- socket() - Method in interface okhttp3.Connection
-
Returns the socket that this connection is using.
- socket() - Method in class okhttp3.internal.connection.RealConnection
-
- socket(Socket) - Method in class okhttp3.internal.http2.Http2Connection.Builder
-
- socket(Socket, String, BufferedSource, BufferedSink) - Method in class okhttp3.internal.http2.Http2Connection.Builder
-
- socketAddress() - Method in class okhttp3.Route
-
- socketFactory() - Method in class okhttp3.Address
-
Returns the socket factory for new connections.
- socketFactory - Variable in class okhttp3.internal.tls.SslClient
-
- socketFactory(SocketFactory) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the socket factory used to create connections.
- socketFactory() - Method in class okhttp3.OkHttpClient
-
- SocketPolicy - Enum in okhttp3.mockwebserver
-
What should be done with the incoming socket.
- source() - Method in class okhttp3.internal.http.RealResponseBody
-
- source(File) - Method in interface okhttp3.internal.io.FileSystem
-
Reads from file.
- source(File) - Method in class okhttp3.internal.io.InMemoryFileSystem
-
- source - Variable in class okhttp3.internal.ws.RealWebSocket.Streams
-
- source() - Method in class okhttp3.ResponseBody
-
- SslClient - Class in okhttp3.internal.tls
-
Combines an SSL socket factory and trust manager, a pairing enough for OkHttp or MockWebServer to
create a secure connection.
- SslClient.Builder - Class in okhttp3.internal.tls
-
- sslContext - Variable in class okhttp3.internal.tls.SslClient
-
- 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
-
- sslSocketFactory(SSLSocketFactory, X509TrustManager) - Method in class okhttp3.OkHttpClient.Builder
-
Sets the socket factory and trust manager used to secure HTTPS connections.
- sslSocketFactory() - Method in class okhttp3.OkHttpClient
-
- start() - Method in class okhttp3.internal.http2.Http2Connection
-
Sends any initial frames and starts reading frames from the remote peer.
- start() - Method in class okhttp3.mockwebserver.MockWebServer
-
Equivalent to start(0).
- start(int) - Method in class okhttp3.mockwebserver.MockWebServer
-
Starts the server on the loopback interface for the given port.
- start(InetAddress, int) - Method in class okhttp3.mockwebserver.MockWebServer
-
Starts the server on the given address and port.
- start() - Method in class okhttp3.slack.OAuthSessionFactory
-
- startRtm() - Method in class okhttp3.slack.SlackClient
-
Starts a real time messaging session.
- StatusLine - Class in okhttp3.internal.http
-
An HTTP response status line like "HTTP/1.1 200 OK".
- StatusLine(Protocol, int, String) - Constructor for class okhttp3.internal.http.StatusLine
-
- StreamAllocation - Class in okhttp3.internal.connection
-
This class coordinates the relationship between three entities:
Connections: physical socket connections to remote servers.
- StreamAllocation(ConnectionPool, Address, Object) - Constructor for class okhttp3.internal.connection.StreamAllocation
-
- streamAllocation() - Method in class okhttp3.internal.http.RealInterceptorChain
-
- streamAllocation() - Method in class okhttp3.internal.http.RetryAndFollowUpInterceptor
-
- streamAllocation(Call) - Method in class okhttp3.internal.Internal
-
- StreamAllocation.StreamAllocationReference - Class in okhttp3.internal.connection
-
- streamFailed(IOException) - Method in class okhttp3.internal.connection.StreamAllocation
-
- streamFinished(boolean, HttpCodec) - Method in class okhttp3.internal.connection.StreamAllocation
-
- StreamResetException - Exception in okhttp3.internal.http2
-
Thrown when an HTTP/2 stream is canceled without damage to the socket that carries it.
- StreamResetException(ErrorCode) - Constructor for exception okhttp3.internal.http2.StreamResetException
-
- Streams(boolean, BufferedSource, BufferedSink) - Constructor for class okhttp3.internal.ws.RealWebSocket.Streams
-
- string() - Method in class okhttp3.ResponseBody
-
Returns the response as a string decoded with the charset of the Content-Type header.
- subjectAlternativeName(String) - Method in class okhttp3.internal.tls.HeldCertificate.Builder
-
Adds a subject alternative name to the certificate.
- subtype() - Method in class okhttp3.MediaType
-
Returns a specific media subtype, such as "plain" or "png", "mpeg", "mp4" or "xml".
- successCount - Variable in class okhttp3.internal.connection.RealConnection
-
- supportsTlsExtensions(boolean) - Method in class okhttp3.ConnectionSpec.Builder
-
- supportsTlsExtensions() - Method in class okhttp3.ConnectionSpec
-
- supportsUrl(HttpUrl) - Method in class okhttp3.internal.connection.RealConnection
-
- SynchronousGet - Class in okhttp3.recipes
-
- SynchronousGet() - Constructor for class okhttp3.recipes.SynchronousGet
-
- SYSTEM - Static variable in interface okhttp3.Dns
-
- SYSTEM - Static variable in interface okhttp3.internal.io.FileSystem
-
The host machine's local file system.
- value(String) - Method in class okhttp3.Cookie.Builder
-
- value() - Method in class okhttp3.Cookie
-
Returns a possibly-empty string with this cookie's value.
- value(int) - Method in class okhttp3.FormBody
-
- value(int) - Method in class okhttp3.Headers
-
Returns the value at index.
- value - Variable in class okhttp3.internal.http2.Header
-
Value in UTF-8 encoding.
- valueOf(String) - Static method in enum okhttp3.internal.http2.ErrorCode
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum okhttp3.logging.HttpLoggingInterceptor.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum okhttp3.mockwebserver.SocketPolicy
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum okhttp3.Protocol
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum okhttp3.TlsVersion
-
Returns the enum constant of this type with the specified name.
- values(String) - Method in class okhttp3.Headers
-
Returns an immutable list of the header values for name.
- values() - Static method in enum okhttp3.internal.http2.ErrorCode
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum okhttp3.logging.HttpLoggingInterceptor.Level
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum okhttp3.mockwebserver.SocketPolicy
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum okhttp3.Protocol
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum okhttp3.TlsVersion
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- varyFields(Headers) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns the names of the request headers that need to be checked for equality when caching.
- varyHeaders(Response) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns the subset of the headers in response's request that impact the content of
response's body.
- varyHeaders(Headers, Headers) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns the subset of the headers in requestHeaders that impact the content of
response's body.
- varyMatches(Response, Headers, Request) - Static method in class okhttp3.internal.http.HttpHeaders
-
Returns true if none of the Vary headers have changed between cachedRequest and newRequest.
- verify(String, SSLSession) - Method in class okhttp3.internal.tls.OkHostnameVerifier
-
- verify(String, X509Certificate) - Method in class okhttp3.internal.tls.OkHostnameVerifier
-
- verify(String, SSLSession) - Method in class okhttp3.RecordingHostnameVerifier
-
- verifyAsIpAddress(String) - Static method in class okhttp3.internal.Util
-
Returns true if host is not a host name and might be an IP address.
- verifyHostname(String, String) - Method in class okhttp3.internal.tls.OkHostnameVerifier
-
Returns true iff hostname matches the domain name pattern.
- version - Variable in class okhttp3.curl.Main
-