com.squareup.square.http.client

Interface HttpClient

All Known Implementing Classes:

OkClient

public interface HttpClient

HTTP Client to send HTTP Requests and read the responses.

Method Summary

Modifier and Type	Method and Description
HttpRequest	delete(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create an HTTP DELETE request with parameters.
HttpBodyRequest	deleteBody(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, Object body) Create an HTTP DELETE request with body.
HttpResponse	execute(HttpRequest request, boolean hasBinaryResponse) Execute a given HttpRequest to get string/binary response back.
HttpResponse	execute(HttpRequest request, boolean hasBinaryResponse, RetryConfiguration retryConfiguration) Execute a given HttpRequest to get string/binary response back.
CompletableFuture<HttpResponse>	executeAsync(HttpRequest request, boolean hasBinaryResponse) Execute a given HttpRequest to get string/binary response back.
CompletableFuture<HttpResponse>	executeAsync(HttpRequest request, boolean hasBinaryResponse, RetryConfiguration retryConfiguration) Execute a given HttpRequest to get string/binary response back.
HttpRequest	get(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create a simple HTTP GET request.
HttpRequest	head(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create a simple HTTP HEAD request.
HttpRequest	patch(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create an HTTP PATCH request with parameters.
HttpBodyRequest	patchBody(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, Object body) Create an HTTP PATCH request with body.
HttpRequest	post(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create an HTTP POST request with parameters.
HttpBodyRequest	postBody(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, Object body) Create an HTTP POST request with body.
HttpRequest	put(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, List<AbstractMap.SimpleEntry<String,Object>> parameters) Create an HTTP PUT request with parameters.
HttpBodyRequest	putBody(StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParams, Object body) Create an HTTP PUT request with body.

Method Detail

executeAsync

CompletableFuture<HttpResponse> executeAsync(HttpRequest request,
                                             boolean hasBinaryResponse)

Execute a given HttpRequest to get string/binary response back.

Parameters:

request - The given HttpRequest to execute.

hasBinaryResponse - Whether the response is binary or string.

Returns:

CompletableFuture of HttpResponse after execution.

executeAsync

CompletableFuture<HttpResponse> executeAsync(HttpRequest request,
                                             boolean hasBinaryResponse,
                                             RetryConfiguration retryConfiguration)

Execute a given HttpRequest to get string/binary response back.

Parameters:

request - The given HttpRequest to execute.

hasBinaryResponse - Whether the response is binary or string.

retryConfiguration - The overridden retry configuration for request.

Returns:

CompletableFuture of HttpResponse after execution.

execute

HttpResponse execute(HttpRequest request,
                     boolean hasBinaryResponse)
              throws IOException

Execute a given HttpRequest to get string/binary response back.

Parameters:

request - The given HttpRequest to execute.

hasBinaryResponse - Whether the response is binary or string.

Returns:

The converted http response.

Throws:

IOException - exception to be thrown while converting response.

execute

HttpResponse execute(HttpRequest request,
                     boolean hasBinaryResponse,
                     RetryConfiguration retryConfiguration)
              throws IOException

Execute a given HttpRequest to get string/binary response back.

Parameters:

request - The given HttpRequest to execute.

hasBinaryResponse - Whether the response is binary or string.

retryConfiguration - The overridden retry configuration for request.

Returns:

The converted http response.

Throws:

IOException - exception to be thrown while converting response.

get

HttpRequest get(StringBuilder queryUrlBuilder,
                Headers headers,
                Map<String,Object> queryParams,
                List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create a simple HTTP GET request.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

head

HttpRequest head(StringBuilder queryUrlBuilder,
                 Headers headers,
                 Map<String,Object> queryParams,
                 List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create a simple HTTP HEAD request.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

post

HttpRequest post(StringBuilder queryUrlBuilder,
                 Headers headers,
                 Map<String,Object> queryParams,
                 List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create an HTTP POST request with parameters.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

postBody

HttpBodyRequest postBody(StringBuilder queryUrlBuilder,
                         Headers headers,
                         Map<String,Object> queryParams,
                         Object body)

Create an HTTP POST request with body.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

body - The object to be sent as body after serialization.

Returns:

Returns the object of HttpBodyRequest

put

HttpRequest put(StringBuilder queryUrlBuilder,
                Headers headers,
                Map<String,Object> queryParams,
                List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create an HTTP PUT request with parameters.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

putBody

HttpBodyRequest putBody(StringBuilder queryUrlBuilder,
                        Headers headers,
                        Map<String,Object> queryParams,
                        Object body)

Create an HTTP PUT request with body.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

body - The object to be sent as body after serialization.

Returns:

Returns the object of HttpBodyRequest

patch

HttpRequest patch(StringBuilder queryUrlBuilder,
                  Headers headers,
                  Map<String,Object> queryParams,
                  List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create an HTTP PATCH request with parameters.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

patchBody

HttpBodyRequest patchBody(StringBuilder queryUrlBuilder,
                          Headers headers,
                          Map<String,Object> queryParams,
                          Object body)

Create an HTTP PATCH request with body.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

body - The object to be sent as body after serialization.

Returns:

Returns the object of HttpBodyRequest

delete

HttpRequest delete(StringBuilder queryUrlBuilder,
                   Headers headers,
                   Map<String,Object> queryParams,
                   List<AbstractMap.SimpleEntry<String,Object>> parameters)

Create an HTTP DELETE request with parameters.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

parameters - The form data values in a key-value map.

Returns:

Returns the object of HttpRequest

deleteBody

HttpBodyRequest deleteBody(StringBuilder queryUrlBuilder,
                           Headers headers,
                           Map<String,Object> queryParams,
                           Object body)

Create an HTTP DELETE request with body.

Parameters:

queryUrlBuilder - The http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent.

queryParams - The query parameters in a key-value map.

body - The object to be sent as body after serialization.

Returns:

Returns the object of HttpBodyRequest