Package com.longbridge

Class HttpClient

java.lang.Object

com.longbridge.HttpClient

All Implemented Interfaces:

AutoCloseable

public class HttpClient
extends Object
implements AutoCloseable

Longbridge OpenAPI HTTP client.

Provides authenticated HTTP access to the Longbridge REST API. Instances are created via the static factory methods fromApikey(java.lang.String, java.lang.String, java.lang.String) or fromApikeyEnv(). The client must be closed after use (it implements AutoCloseable).

Method Summary

Modifier and Type	Method	Description
void	close()
static HttpClient	fromApikey(String appKey, String appSecret, String accessToken)	Create a new HttpClient using API Key authentication.
static HttpClient	fromApikey(String appKey, String appSecret, String accessToken, String httpUrl)	Create a new HttpClient using API Key authentication with a custom HTTP endpoint URL.
static HttpClient	fromApikeyEnv()	Create a new HttpClient from environment variables (API Key authentication).
static HttpClient	fromOAuth(OAuth oauth)	Create a new HttpClient from an OAuth handle.
static HttpClient	fromOAuth(OAuth oauth, String httpUrl)	Create a new HttpClient from an OAuth handle with a custom HTTP endpoint URL.
<T> CompletableFuture<T>	request(Class<T> respClass, String method, String path)	Performs a HTTP request
<T> CompletableFuture<T>	request(Class<T> respClass, String method, String path, Object requestBody)	Performs a HTTP request with body
<T> CompletableFuture<T>	request(Class<T> respClass, String method, String path, Object requestBody, HashMap<String,String> headers)	Performs a HTTP request with headers

Methods inherited from class java.lang.Object

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

Method Detail

fromApikey

public static HttpClient fromApikey(String appKey,
                                    String appSecret,
                                    String accessToken)

Create a new HttpClient using API Key authentication.

LONGBRIDGE_HTTP_URL is read from the environment automatically.

Parameters:

appKey - App key

appSecret - App secret

accessToken - Access token

Returns:

HttpClient object

fromApikey

public static HttpClient fromApikey(String appKey,
                                    String appSecret,
                                    String accessToken,
                                    String httpUrl)

Create a new HttpClient using API Key authentication with a custom HTTP endpoint URL.

The httpUrl parameter overrides LONGBRIDGE_HTTP_URL from the environment.

Parameters:

appKey - App key

appSecret - App secret

accessToken - Access token

httpUrl - HTTP endpoint URL override

Returns:

HttpClient object

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

fromApikeyEnv

public static HttpClient fromApikeyEnv()
                                throws OpenApiException

Create a new HttpClient from environment variables (API Key authentication).

Variables: LONGBRIDGE_HTTP_URL, LONGBRIDGE_APP_KEY, LONGBRIDGE_APP_SECRET, LONGBRIDGE_ACCESS_TOKEN

Returns:

HttpClient object

Throws:

OpenApiException - If an error occurs

fromOAuth

public static HttpClient fromOAuth(OAuth oauth)

Create a new HttpClient from an OAuth handle.

LONGBRIDGE_HTTP_URL is read from the environment automatically.

Parameters:

oauth - OAuth handle returned by OAuthBuilder.build(java.util.function.Consumer<java.lang.String>)

Returns:

HttpClient object

fromOAuth

public static HttpClient fromOAuth(OAuth oauth,
                                   String httpUrl)

Create a new HttpClient from an OAuth handle with a custom HTTP endpoint URL.

The httpUrl parameter overrides LONGBRIDGE_HTTP_URL from the environment.

Parameters:

oauth - OAuth handle returned by OAuthBuilder.build(java.util.function.Consumer<java.lang.String>)

httpUrl - HTTP endpoint URL override

Returns:

HttpClient object

request

public <T> CompletableFuture<T> request(Class<T> respClass,
                                        String method,
                                        String path)
                                 throws RuntimeException

Performs a HTTP request

Type Parameters:

T - Response class type

Parameters:

respClass - Response class object, it can be null

method - HTTP method, e.g. get, post

path - Request path

Returns:

A Future representing the result of the operation

Throws:

RuntimeException - If an error occurs

request

public <T> CompletableFuture<T> request(Class<T> respClass,
                                        String method,
                                        String path,
                                        Object requestBody)
                                 throws RuntimeException

Performs a HTTP request with body

Type Parameters:

T - Response class type

Parameters:

respClass - Response class object, it can be null

method - HTTP method, e.g. get, post

path - Request path

requestBody - Request body, it can be null

Returns:

A Future representing the result of the operation

Throws:

RuntimeException - If an error occurs

request

public <T> CompletableFuture<T> request(Class<T> respClass,
                                        String method,
                                        String path,
                                        Object requestBody,
                                        HashMap<String,String> headers)
                                 throws RuntimeException

Performs a HTTP request with headers

Type Parameters:

T - Response class type

Parameters:

respClass - Response class object, it can be null

method - HTTP method, e.g. get, post

path - Request path

requestBody - Request body, it can be null

headers - Request headers, it can be null

Returns:

A Future representing the result of the operation

Throws:

RuntimeException - If the request fails