Package org.consensusj.jsonrpc

Class DefaultRpcClient

java.lang.Object

org.consensusj.jsonrpc.DefaultRpcClient

All Implemented Interfaces:

AutoCloseable, AsyncSupport, JsonRpcClient<JavaType>, JsonRpcTransport<JavaType>

Direct Known Subclasses:

BitcoinClient, EthereumClient

public class DefaultRpcClient
extends Object
implements JsonRpcClient<JavaType>

A strongly-typed, Jackson-based JSON-RPC client. JsonRpcClient provides many convenience send `default` methods in a JSON-library-independent way. DefaultRpcClient provides the needed implementation support for Jackson. This class implements the constructors, static fields, and getters, but delegates the core JsonRpcTransport.sendRequestForResponseAsync(JsonRpcRequest, Type) method to a JsonRpcTransport implementation component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultRpcClient.TransientErrorMapper<T>	Functional interface for ignoring what are considered "transient" errors.
static interface	DefaultRpcClient.TransportFactory	Functional interface for creating JsonRpcTransport instances.

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

AsyncSupport.ThrowingSupplier<T>, AsyncSupport.TransientErrorFilter

Field Summary

Fields

Modifier and Type	Field	Description
protected final JsonRpcMessage.Version	jsonRpcVersion
protected final ObjectMapper	mapper

Constructor Summary

Constructors

Constructor	Description
DefaultRpcClient(URI server, String rpcUser, String rpcPassword)
DefaultRpcClient(SSLContext sslContext, JsonRpcMessage.Version jsonRpcVersion, URI server, String rpcUser, String rpcPassword)
DefaultRpcClient(DefaultRpcClient.TransportFactory transportFactory, JsonRpcMessage.Version jsonRpcVersion)
DefaultRpcClient(JsonRpcMessage.Version jsonRpcVersion, URI server, String rpcUser, String rpcPassword)

Method Summary

Modifier and Type	Method	Description
JavaType	collectionTypeForClasses(Class<? extends Collection> collection, JavaType type)
JavaType	collectionTypeForClasses(Class<? extends Collection> collection, Class<?> clazz)
JavaType	defaultType()
JsonRpcMessage.Version	getJsonRpcVersion()	Return the JSON-RPC version used by the implementation
ObjectMapper	getMapper()
URI	getServerURI()	Get the URI of the remote server
protected <T> CompletableFuture<JsonRpcResponse<T>>	identityTransientErrorMapper(JsonRpcRequest request, JsonRpcResponse<T> response, Throwable t)	Transient error mapper that is a no-op, i.e.
<T> CompletableFuture<JsonRpcResponse<T>>	pollOnce(JsonRpcRequest request, JavaType resultType, DefaultRpcClient.TransientErrorMapper<T> errorMapper)
JavaType	responseTypeFor(JavaType resultType)
JavaType	responseTypeFor(Class<?> resultType)
CompletableFuture<JsonRpcResponse<JsonNode>>	sendRequestForResponseAsync(JsonRpcRequest request)	Convenience method for requesting an asynchronous response with a JsonNode for the result.
<R> CompletableFuture<JsonRpcResponse<R>>	sendRequestForResponseAsync(JsonRpcRequest request, JavaType responseType)	Send a JsonRpcRequest for a JsonRpcResponse asynchronously.
protected String	statusFromErrorResponse(JsonRpcResponse<?> response)
protected <T> JsonRpcResponse<T>	temporarilyUnavailableResponse(JsonRpcRequest request, Throwable t)
JavaType	typeForClass(Class<?> clazz)
<T> CompletableFuture<T>	waitForServer(Duration timeout, Duration retry, Supplier<JsonRpcRequest> requestSupplier, JavaType resultType, DefaultRpcClient.TransientErrorMapper<T> errorMapper)	A wait-for-server routine that is agnostic about which RPC methods the server supports.
<T> CompletableFuture<T>	waitForServer(Duration timeout, Duration retry, Supplier<JsonRpcRequest> requestSupplier, DefaultRpcClient.TransientErrorMapper<T> errorMapper)	A wait-for-server routine that is agnostic about which RPC methods the server supports.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.consensusj.jsonrpc.AsyncSupport

getDefaultAsyncExecutor, supplyAsync, supplyAsync

Methods inherited from interface org.consensusj.jsonrpc.JsonRpcClient

buildJsonRequest, buildJsonRequest, close, send, send, send, send, send, send, sendAsync, sendAsync, sendAsync, sendAsync, sendAsync

Methods inherited from interface org.consensusj.jsonrpc.JsonRpcTransport

sendRequestForResponse, syncGet

Field Details

jsonRpcVersion

protected final JsonRpcMessage.Version jsonRpcVersion

mapper

protected final ObjectMapper mapper

Constructor Details

DefaultRpcClient

public DefaultRpcClient(URI server,
 String rpcUser,
 String rpcPassword)

DefaultRpcClient

public DefaultRpcClient(JsonRpcMessage.Version jsonRpcVersion,
 URI server,
 String rpcUser,
 String rpcPassword)

DefaultRpcClient

public DefaultRpcClient(SSLContext sslContext,
 JsonRpcMessage.Version jsonRpcVersion,
 URI server,
 String rpcUser,
 String rpcPassword)

DefaultRpcClient

public DefaultRpcClient(DefaultRpcClient.TransportFactory transportFactory,
 JsonRpcMessage.Version jsonRpcVersion)

Method Details

getJsonRpcVersion

public JsonRpcMessage.Version getJsonRpcVersion()

Description copied from interface: JsonRpcClient

Return the JSON-RPC version used by the implementation

Specified by:

getJsonRpcVersion in interface JsonRpcClient<JavaType>

Returns:

JSON-RPC version

getServerURI

public URI getServerURI()

Description copied from interface: JsonRpcTransport

Get the URI of the remote server

Specified by:

getServerURI in interface JsonRpcTransport<JavaType>

Returns:

URI of remote server

sendRequestForResponseAsync

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

Description copied from interface: JsonRpcTransport

Send a JsonRpcRequest for a JsonRpcResponse asynchronously.

Specified by:

sendRequestForResponseAsync in interface JsonRpcTransport<JavaType>

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`

sendRequestForResponseAsync

public CompletableFuture<JsonRpcResponse<JsonNode>> sendRequestForResponseAsync(JsonRpcRequest request)

Convenience method for requesting an asynchronous response with a JsonNode for the result.

Parameters:

request - The request to send

Returns:

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

getMapper

public ObjectMapper getMapper()

defaultType

public JavaType defaultType()

Specified by:

defaultType in interface JsonRpcClient<JavaType>

responseTypeFor

public JavaType responseTypeFor(JavaType resultType)

Specified by:

responseTypeFor in interface JsonRpcClient<JavaType>

responseTypeFor

public JavaType responseTypeFor(Class<?> resultType)

Specified by:

responseTypeFor in interface JsonRpcClient<JavaType>

typeForClass

public JavaType typeForClass(Class<?> clazz)

Specified by:

typeForClass in interface JsonRpcClient<JavaType>

collectionTypeForClasses

public JavaType collectionTypeForClasses(Class<? extends Collection> collection,
 Class<?> clazz)

Specified by:

collectionTypeForClasses in interface JsonRpcClient<JavaType>

collectionTypeForClasses

public JavaType collectionTypeForClasses(Class<? extends Collection> collection,
 JavaType type)

Specified by:

collectionTypeForClasses in interface JsonRpcClient<JavaType>

pollOnce

public <T> CompletableFuture<JsonRpcResponse<T>> pollOnce(JsonRpcRequest request,
 JavaType resultType,
 DefaultRpcClient.TransientErrorMapper<T> errorMapper)

waitForServer

public <T> CompletableFuture<T> waitForServer(Duration timeout,
 Duration retry,
 Supplier<JsonRpcRequest> requestSupplier,
 DefaultRpcClient.TransientErrorMapper<T> errorMapper)

A wait-for-server routine that is agnostic about which RPC methods the server supports. In addition to two Duration parameters, there are 2 lambda parameters to enable this method to work with any JSON-RPC server. This version will tell the JSON-RPC Mapper to return an JsonRpcResponse with a result of type Object. If you need more precise control over the type, use waitForServer(Duration, Duration, Supplier, JavaType, TransientErrorMapper).

Type Parameters:

T - The desired result type to be returned when the server is running

Parameters:

timeout - how long to wait

retry - delay between retries

requestSupplier - supplier of requests (needs to increment request ID at the very least)

errorMapper - function that maps non-fatal errors (i.e. cases to keep polling)

Returns:

A future that returns a successful

waitForServer

public <T> CompletableFuture<T> waitForServer(Duration timeout,
 Duration retry,
 Supplier<JsonRpcRequest> requestSupplier,
 JavaType resultType,
 DefaultRpcClient.TransientErrorMapper<T> errorMapper)

A wait-for-server routine that is agnostic about which RPC methods the server supports. In addition to two Duration parameters, there are 3 parameters (2 functions and a generic type specifier) to enable this method to work with any JSON-RPC server.

Type Parameters:

T - The desired result type to be returned when the server is running

Parameters:

timeout - how long to wait

retry - delay between retries

requestSupplier - supplier of requests (needs to increment request ID at the very least)

resultType - the result type for the response

errorMapper - function that maps non-fatal errors (i.e. cases to keep polling)

Returns:

A future that returns a successful

identityTransientErrorMapper

protected <T> CompletableFuture<JsonRpcResponse<T>> identityTransientErrorMapper(JsonRpcRequest request,
 JsonRpcResponse<T> response,
 Throwable t)

Transient error mapper that is a no-op, i.e. it passes all errors through unchanged.

temporarilyUnavailableResponse

protected <T> JsonRpcResponse<T> temporarilyUnavailableResponse(JsonRpcRequest request,
 Throwable t)

statusFromErrorResponse

protected String statusFromErrorResponse(JsonRpcResponse<?> response)

Parameters:

response - A response where getResult() == null

Returns:

An error status string suitable for log messages