com.squareup.square.http.client

Class OkClient

java.lang.Object

com.squareup.square.http.client.OkClient

All Implemented Interfaces:

HttpClient

public class OkClient
extends Object
implements HttpClient

HTTP Client class to send HTTP Requests and read the responses.

Constructor Summary

Constructors

Constructor and Description
OkClient(ReadonlyHttpClientConfiguration httpClientConfig) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected static HttpResponse	convertResponse(HttpRequest request, okhttp3.Response response, boolean hasBinaryResponse) Converts a given OkHttp response into our internal http response model.
HttpRequest	delete(StringBuilder queryUrl, 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 httpRequest, boolean hasBinaryResponse) Execute a given HttpRequest to get string/binary response back.
HttpResponse	execute(HttpRequest httpRequest, boolean hasBinaryResponse, RetryConfiguration retryConfiguration) Execute a given HttpRequest to get string/binary response back.
CompletableFuture<HttpResponse>	executeAsync(HttpRequest httpRequest, boolean hasBinaryResponse) Execute a given HttpRequest to get string/binary response back.
CompletableFuture<HttpResponse>	executeAsync(HttpRequest httpRequest, 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.
static void	shutdown() Shutdown the underlying OkHttpClient instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OkClient

public OkClient(ReadonlyHttpClientConfiguration httpClientConfig)

Default constructor.

Parameters:

httpClientConfig - The specified http client configuration.

Method Detail

shutdown

public static void shutdown()

Shutdown the underlying OkHttpClient instance.

executeAsync

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

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

Specified by:

executeAsync in interface HttpClient

Parameters:

httpRequest - 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.

executeAsync

public CompletableFuture<HttpResponse> executeAsync(HttpRequest httpRequest,
                                                    boolean hasBinaryResponse)

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

Specified by:

executeAsync in interface HttpClient

Parameters:

httpRequest - The given HttpRequest to execute.

hasBinaryResponse - Whether the response is binary or string.

Returns:

CompletableFuture of HttpResponse after execution.

execute

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

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

Specified by:

execute in interface HttpClient

Parameters:

httpRequest - 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.

execute

public HttpResponse execute(HttpRequest httpRequest,
                            boolean hasBinaryResponse)
                     throws IOException

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

Specified by:

execute in interface HttpClient

Parameters:

httpRequest - 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.

convertResponse

protected static HttpResponse convertResponse(HttpRequest request,
                                              okhttp3.Response response,
                                              boolean hasBinaryResponse)
                                       throws IOException

Converts a given OkHttp response into our internal http response model.

Parameters:

request - The given http request in internal format.

response - The given OkHttp response.

hasBinaryResponse - Whether the response is binary or string.

Returns:

The converted http response.

Throws:

IOException - exception to be thrown while converting response.

get

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

Create a simple HTTP GET request.

Specified by:

get in interface HttpClient

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

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

Create a simple HTTP HEAD request.

Specified by:

head in interface HttpClient

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

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

Create an HTTP POST request with parameters.

Specified by:

post in interface HttpClient

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

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

Create an HTTP POST request with body.

Specified by:

postBody in interface HttpClient

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

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

Create an HTTP PUT request with parameters.

Specified by:

put in interface HttpClient

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

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

Create an HTTP PUT request with body.

Specified by:

putBody in interface HttpClient

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

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

Create an HTTP PATCH request with parameters.

Specified by:

patch in interface HttpClient

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

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

Create an HTTP PATCH request with body.

Specified by:

patchBody in interface HttpClient

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

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

Create an HTTP DELETE request with parameters.

Specified by:

delete in interface HttpClient

Parameters:

queryUrl - 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

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

Create an HTTP DELETE request with body.

Specified by:

deleteBody in interface HttpClient

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