Package org.consensusj.jsonrpc

Interface JsonRpcTransport<T extends Type>

All Superinterfaces:

AsyncSupport

All Known Subinterfaces:

JsonRpcClient<T>

All Known Implementing Classes:

BitcoinClient, BitcoinExtendedClient, DefaultRpcClient, EthereumClient, JsonRpcClientHttpUrlConnection, JsonRpcClientJavaNet, NamecoinClient, RxBitcoinClient

public interface JsonRpcTransport<T extends Type>
extends AsyncSupport

Defines the interface for a network-layer implementation of a JSON-RPC client.

Nested Class Summary

Nested classes/interfaces inherited from interface org.consensusj.jsonrpc.AsyncSupport

AsyncSupport.ThrowingSupplier<T>, AsyncSupport.TransientErrorFilter

Method Summary

Modifier and Type	Method	Description
static String	base64Encode(String authString)	Encode username password as Base64 for basic authentication
static SSLContext	getDefaultSSLContext()	Return the default SSLContext without declaring a checked exception
URI	getServerURI()	Get the URI of the remote server
default <R> JsonRpcResponse<R>	sendRequestForResponse(JsonRpcRequest request, T responseType)	Send a JsonRpcRequest for a JsonRpcResponse
<R> CompletableFuture<JsonRpcResponse<R>>	sendRequestForResponseAsync(JsonRpcRequest request, T responseType)	Send a JsonRpcRequest for a JsonRpcResponse asynchronously.
default <R> R	syncGet(CompletableFuture<R> future)	Synchronously complete a JSON-RPC request by calling CompletableFuture.get(), unwrapping nested JsonRpcException or IOException from ExecutionException.

Methods inherited from interface org.consensusj.jsonrpc.AsyncSupport

getDefaultAsyncExecutor, supplyAsync, supplyAsync

Method Details

getServerURI

URI getServerURI()

Get the URI of the remote server

Returns:

URI of remote server

sendRequestForResponse

default <R> JsonRpcResponse<R> sendRequestForResponse(JsonRpcRequest request,
 T responseType)
                                               throws IOException,
JsonRpcStatusException

Send a JsonRpcRequest for a JsonRpcResponse

Synchronous subclasses should override this method to prevent CompletableFuture.supplyAsync(Supplier) from being called twice when AsyncSupport is being used. Eventually we'll migrate more of the codebase to native async, and then we won't have to worry about calling supplyAsync twice.

Type Parameters:

R - Type of result object

Parameters:

request - The request to send

responseType - The response type expected (used by Jackson for conversion)

Returns:

A JSON RPC Response with `result` of type `R`

Throws:

IOException - network error

JsonRpcStatusException - JSON RPC status error

sendRequestForResponseAsync

<R> CompletableFuture<JsonRpcResponse<R>> sendRequestForResponseAsync(JsonRpcRequest request,
 T responseType)

Send a JsonRpcRequest for a JsonRpcResponse asynchronously.

Type Parameters:

R - Type of result object

Parameters:

request - The request to send

responseType - The response type expected (used by Jackson for conversion)

Returns:

A future JSON RPC Response with `result` of type `R`

syncGet

default <R> R syncGet(CompletableFuture<R> future)
               throws IOException,
JsonRpcException

Synchronously complete a JSON-RPC request by calling CompletableFuture.get(), unwrapping nested JsonRpcException or IOException from ExecutionException.

Type Parameters:

R - The expected result type

Parameters:

future - The CompletableFuture (result of JSON-RPC request) to unwrap

Returns:

A JSON-RPC result

Throws:

IOException - If CompletableFuture.get() threw ExecutionException caused by IOException

JsonRpcException - If CompletableFuture.get() threw ExecutionException caused by JsonRpcException

RuntimeException - If CompletableFuture.get() threw InterruptedException or other ExecutionException.

base64Encode

static String base64Encode(String authString)

Encode username password as Base64 for basic authentication

We're using Base64, which requires Android 8.0 or later.

Parameters:

authString - An authorization string of the form `username:password`

Returns:

A compliant Base64 encoding of `authString`

getDefaultSSLContext

static SSLContext getDefaultSSLContext()

Return the default SSLContext without declaring a checked exception

Returns:

The default SSLContext