cloud.metaapi.sdk.clients

Class HttpClient

java.lang.Object

cloud.metaapi.sdk.clients.HttpClient

Direct Known Subclasses:

HttpClientMock

public class HttpClient
extends Object

HTTP client library based on request-promise

Constructor Summary

Constructors

Constructor and Description
HttpClient() Constructs HttpClient class instance.
HttpClient(int requestTimeout, int connectTimeout) Constructs HttpClient class instance
HttpClient(int requestTimeout, int connectTimeout, RetryOptions retryOpts) Constructs HttpClient class instance

Method Summary

Modifier and Type	Method and Description
protected CompletableFuture<kong.unirest.HttpResponse<String>>	makeCheckedRequest(HttpRequestOptions options, int retryCounter, long endTime) Performs a request.
protected CompletableFuture<kong.unirest.HttpResponse<String>>	makeRequest(HttpRequestOptions options) Makes request and returns HTTP response.
CompletableFuture<String>	request(HttpRequestOptions options) Performs a request.
CompletableFuture<String>	request(HttpRequestOptions options, int retryCounter) Performs a request.
<T> CompletableFuture<T>	requestJson(HttpRequestOptions options, Class<T> valueType) Does the same as request(HttpRequestOptions) but automatically converts response into json.
<T> CompletableFuture<T>	requestJson(HttpRequestOptions options, Class<T> valueType, int retryCounter) Does the same as request(HttpRequestOptions) but automatically converts response into json.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient

public HttpClient()
           throws ValidationException

Constructs HttpClient class instance. Connect and request timeout are 1 minute each.

Throws:

ValidationException - if specified options are invalid

HttpClient

public HttpClient(int requestTimeout,
                  int connectTimeout)
           throws ValidationException

Constructs HttpClient class instance

Parameters:

requestTimeout - request timeout in milliseconds

connectTimeout - connect timeout in milliseconds

Throws:

ValidationException - if specified options are invalid

HttpClient

public HttpClient(int requestTimeout,
                  int connectTimeout,
                  RetryOptions retryOpts)
           throws ValidationException

Constructs HttpClient class instance

Parameters:

requestTimeout - request timeout in milliseconds

connectTimeout - connect timeout in milliseconds

retryOpts - retrying options

Throws:

ValidationException - if specified options are invalid

Method Detail

request

public CompletableFuture<String> request(HttpRequestOptions options)

Performs a request. Completable future response errors are returned as ApiError or subclasses. Also see makeRequest(HttpRequestOptions) for more information about the result completion cases.

Parameters:

options - request options

Returns:

completable future with request results

request

public CompletableFuture<String> request(HttpRequestOptions options,
                                         int retryCounter)

Performs a request. Completable future response errors are returned as ApiError or subclasses. Also see makeRequest(HttpRequestOptions) for more information about the result completion cases.

Parameters:

options - request options

retryCounter - retry counter

Returns:

completable future with request results

requestJson

public <T> CompletableFuture<T> requestJson(HttpRequestOptions options,
                                            Class<T> valueType)

Does the same as request(HttpRequestOptions) but automatically converts response into json. If there is a json parsing error, completes exceptionally with JsonProcessingException.

Type Parameters:

T - any DTO object that can be converted from json

Parameters:

options - request options

valueType - class into which the response will be transformed

Returns:

completable future with request results as json

requestJson

public <T> CompletableFuture<T> requestJson(HttpRequestOptions options,
                                            Class<T> valueType,
                                            int retryCounter)

Does the same as request(HttpRequestOptions) but automatically converts response into json. If there is a json parsing error, completes exceptionally with JsonProcessingException.

Type Parameters:

T - any DTO object that can be converted from json

Parameters:

options - request options

valueType - class into which the response will be transformed

retryCounter - retry counter

Returns:

completable future with request results as json

makeCheckedRequest

protected CompletableFuture<kong.unirest.HttpResponse<String>> makeCheckedRequest(HttpRequestOptions options,
                                                                                  int retryCounter,
                                                                                  long endTime)

Performs a request. Completable future response errors are returned as ApiError or subclasses. Also see makeRequest(HttpRequestOptions) for more information about the result completion cases.

Parameters:

options - request options

retryCounter - retry counter

endTime - request end time as timeout

Returns:

completable future with request response

makeRequest

protected CompletableFuture<kong.unirest.HttpResponse<String>> makeRequest(HttpRequestOptions options)

Makes request and returns HTTP response. If request fails, completable future completes exceptionally with UnirestException.

Parameters:

options - request options

Returns:

completable future resolving with http response object