A B C D E G H I O P R S U W

A

authHeader - Variable in class com.cloudant.http.interceptors.BasicAuthInterceptor

B

BasicAuthInterceptor - Class in com.cloudant.http.interceptors

Adds basic authentication support to HTTP requests by adding an Authorization header.

BasicAuthInterceptor(String) - Constructor for class com.cloudant.http.interceptors.BasicAuthInterceptor

Constructs a BasicAuthInterceptor using userinfo details.

BasicAuthInterceptor(String, String) - Constructor for class com.cloudant.http.interceptors.BasicAuthInterceptor

C

com.cloudant.http - package com.cloudant.http

This package provides the classes for interacting with HTTP.

com.cloudant.http.interceptors - package com.cloudant.http.interceptors

connect(String, URL, String) - Static method in class com.cloudant.http.Http

connect(String, URI, String) - Static method in class com.cloudant.http.Http

connection - Variable in class com.cloudant.http.HttpConnectionInterceptorContext

connectionFactory - Variable in class com.cloudant.http.HttpConnection

A connectionFactory for opening the URLs, can be set, but configured with a default

createFromCredentials(String, String) - Static method in class com.cloudant.http.interceptors.BasicAuthInterceptor

Returns a BasicAuthInterceptor configured using the username and password provided.

D

DELETE(URL) - Static method in class com.cloudant.http.Http

DELETE(URI) - Static method in class com.cloudant.http.Http

disconnect() - Method in class com.cloudant.http.HttpConnection

Disconnect the underlying HttpURLConnection.

E

encodedAuth - Variable in class com.cloudant.http.interceptors.BasicAuthInterceptor

execute() - Method in class com.cloudant.http.HttpConnection

Execute request without returning data from server.

G

GET(URL) - Static method in class com.cloudant.http.Http

GET(URI) - Static method in class com.cloudant.http.Http

getConnection() - Method in class com.cloudant.http.HttpConnection

Get the underlying HttpURLConnection object, allowing clients to set/get properties not exposed here.

getInputStream() - Method in interface com.cloudant.http.HttpConnection.InputStreamGenerator

Implementors must return an InputStream that is ready to read from the beginning.

getNumberOfRetriesRemaining() - Method in class com.cloudant.http.HttpConnection

getState(HttpConnectionInterceptor, String, Class<T>) - Method in class com.cloudant.http.HttpConnectionInterceptorContext

Retrieve the state object associated with the specified interceptor instance and property name on this request context.

H

HEAD(URL) - Static method in class com.cloudant.http.Http

HEAD(URI) - Static method in class com.cloudant.http.Http

Http - Class in com.cloudant.http

Factory methods for obtaining HttpConnections.

Http() - Constructor for class com.cloudant.http.Http

HttpConnection - Class in com.cloudant.http

A wrapper for HttpURLConnections.

HttpConnection(String, URL, String) - Constructor for class com.cloudant.http.HttpConnection

HttpConnection.HttpUrlConnectionFactory - Interface in com.cloudant.http

Factory used by HttpConnection to produce HttpUrlConnections.

HttpConnection.InputStreamGenerator - Interface in com.cloudant.http

An InputStreamGenerator has a single method getInputStream.

HttpConnectionInterceptor - Interface in com.cloudant.http

A marker interface for all HttpConnectionInterceptors.

HttpConnectionInterceptorContext - Class in com.cloudant.http

Provides the context for a HttpConnectionInterceptor.

HttpConnectionInterceptorContext(HttpConnection) - Constructor for class com.cloudant.http.HttpConnectionInterceptorContext

Constructor

HttpConnectionInterceptorContext(HttpConnectionInterceptorContext) - Constructor for class com.cloudant.http.HttpConnectionInterceptorContext

Shallow copy constructor

HttpConnectionRequestInterceptor - Interface in com.cloudant.http

A Request Interceptor is run before the request is made to the server.

HttpConnectionResponseInterceptor - Interface in com.cloudant.http

A Response Interceptor is run after the response is obtained from the server but before the output stream is returned to the original client.

I

interceptRequest(HttpConnectionInterceptorContext) - Method in interface com.cloudant.http.HttpConnectionRequestInterceptor

Intercept the request.

interceptRequest(HttpConnectionInterceptorContext) - Method in class com.cloudant.http.interceptors.BasicAuthInterceptor

interceptResponse(HttpConnectionInterceptorContext) - Method in interface com.cloudant.http.HttpConnectionResponseInterceptor

Intercept the response This method must not do any of the following Return null Read the response stream

interceptResponse(HttpConnectionInterceptorContext) - Method in class com.cloudant.http.interceptors.Replay429Interceptor

O

openConnection(URL) - Method in interface com.cloudant.http.HttpConnection.HttpUrlConnectionFactory

Called by HttpConnection to open URLs, can be implemented to provide customization.

P

POST(URL, String) - Static method in class com.cloudant.http.Http

POST(URI, String) - Static method in class com.cloudant.http.Http

PUT(URL, String) - Static method in class com.cloudant.http.Http

PUT(URI, String) - Static method in class com.cloudant.http.Http

R

Replay429Interceptor - Class in com.cloudant.http.interceptors

An implementation of HttpConnectionResponseInterceptor that retries requests if they receive a 429 Too Many Requests response.

Replay429Interceptor(int, long) - Constructor for class com.cloudant.http.interceptors.Replay429Interceptor

Construct a new Replay429Interceptor with a customized number of retries and initial backoff time.

Replay429Interceptor(int, long, boolean) - Constructor for class com.cloudant.http.interceptors.Replay429Interceptor

Construct a new Replay429Interceptor with a customized number of retries and initial backoff time, specifying whether to honour Retry-After headers sent from the server.

replayRequest - Variable in class com.cloudant.http.HttpConnectionInterceptorContext

requestInterceptors - Variable in class com.cloudant.http.HttpConnection

requestProperties - Variable in class com.cloudant.http.HttpConnection

responseAsBytes() - Method in class com.cloudant.http.HttpConnection

Return response body data from server as a byte array.

responseAsInputStream() - Method in class com.cloudant.http.HttpConnection

Return response body data from server as an InputStream.

responseAsString() - Method in class com.cloudant.http.HttpConnection

Return response body data from server as a String.

responseInterceptors - Variable in class com.cloudant.http.HttpConnection

S

setNumberOfRetries(int) - Method in class com.cloudant.http.HttpConnection

Sets the number of times this request can be attempted.

setProxy(URL) - Method in interface com.cloudant.http.HttpConnection.HttpUrlConnectionFactory

Set a proxy server address.

setProxyAuthentication(PasswordAuthentication) - Method in interface com.cloudant.http.HttpConnection.HttpUrlConnectionFactory

Set an authenticator to be used to provide credentials for the connection to the proxy server defined by the URL passed to HttpConnection.HttpUrlConnectionFactory.setProxy(URL).

setRequestBody(String) - Method in class com.cloudant.http.HttpConnection

Set the String of request body data to be sent to the server.

setRequestBody(byte[]) - Method in class com.cloudant.http.HttpConnection

Set the byte array of request body data to be sent to the server.

setRequestBody(InputStream) - Method in class com.cloudant.http.HttpConnection

Deprecated.

Use HttpConnection.setRequestBody(InputStreamGenerator)

setRequestBody(InputStream, long) - Method in class com.cloudant.http.HttpConnection

Deprecated.

Use HttpConnection.setRequestBody(InputStreamGenerator, long)

setRequestBody(HttpConnection.InputStreamGenerator) - Method in class com.cloudant.http.HttpConnection

Set an InputStreamGenerator for an InputStream of request body data to be sent to the server.

setRequestBody(HttpConnection.InputStreamGenerator, long) - Method in class com.cloudant.http.HttpConnection

Set an InputStreamGenerator for an InputStream, of known length, of request body data to be sent to the server.

setState(HttpConnectionInterceptor, String, T) - Method in class com.cloudant.http.HttpConnectionInterceptorContext

Store some state on this request context associated with the specified interceptor instance.

shutdown() - Method in interface com.cloudant.http.HttpConnection.HttpUrlConnectionFactory

Give the connection provider an opportunity to clean up

U

url - Variable in class com.cloudant.http.HttpConnection

W

WITH_DEFAULTS - Static variable in class com.cloudant.http.interceptors.Replay429Interceptor

Get an instance of a Replay429Interceptor configured with the defaults of 3 retries starting at a 250 ms backoff and preferring any Retry-After header that may be sent by the server.

A B C D E G H I O P R S U W