net.inveed.jsonrpc.client

Class JsonRpcClient

java.lang.Object

net.inveed.jsonrpc.client.JsonRpcClient

public class JsonRpcClient
extends Object

JSON-RPC client. Represents a factory for a fluent client API RequestBuilder. It's parametrized by Transport and Jackson ObjectMapper

Constructor Summary

Constructors

Constructor and Description
JsonRpcClient(Transport transport) Constructs a new JSON-RPC client with a specified transport
JsonRpcClient(Transport transport, com.fasterxml.jackson.databind.ObjectMapper mapper) Constructs a new JSON-RPC client with a specified transport and user-definder JSON mapper

Method Summary

Modifier and Type	Method and Description
BatchRequestBuilder<?,?>	createBatchRequest() Creates a builder of a JSON-RPC batch request in initial state
NotificationRequestBuilder	createNotification() Creates a builder of a JSON-RPC notification request in initial state
RequestBuilder<Object>	createRequest() Creates a builder of a JSON-RPC request in initial state
<T> T	onDemand(Class<T> clazz) Creates a new proxy for accessing a remote JSON-RPC service through an interface
<T> T	onDemand(Class<T> clazz, IdGenerator<?> idGenerator) Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom id generator that overrides the interface generator.
<T> T	onDemand(Class<T> clazz, ParamsType paramsType) Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom type of request params.
<T> T	onDemand(Class<T> clazz, ParamsType paramsType, IdGenerator<?> idGenerator) Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom id generator and custom type of request params.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRpcClient

public JsonRpcClient(Transport transport)

Constructs a new JSON-RPC client with a specified transport

Parameters:

transport - transport implementation

JsonRpcClient

public JsonRpcClient(Transport transport,
                     com.fasterxml.jackson.databind.ObjectMapper mapper)

Constructs a new JSON-RPC client with a specified transport and user-definder JSON mapper

Parameters:

transport - transport implementation

mapper - JSON mapper

Method Detail

createRequest

public RequestBuilder<Object> createRequest()

Creates a builder of a JSON-RPC request in initial state

Returns:

request builder

createNotification

public NotificationRequestBuilder createNotification()

Creates a builder of a JSON-RPC notification request in initial state

Returns:

notification request builder

createBatchRequest

public BatchRequestBuilder<?,?> createBatchRequest()

Creates a builder of a JSON-RPC batch request in initial state

Returns:

batch request builder

onDemand

public <T> T onDemand(Class<T> clazz)

Creates a new proxy for accessing a remote JSON-RPC service through an interface

Type Parameters:

T - interface type

Parameters:

clazz - interface metadata

Returns:

a new proxy

onDemand

public <T> T onDemand(Class<T> clazz,
                      IdGenerator<?> idGenerator)

Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom id generator that overrides the interface generator.

Type Parameters:

T - interface type

Parameters:

clazz - interface metadata

idGenerator - custom id generator

Returns:

a new proxy

onDemand

public <T> T onDemand(Class<T> clazz,
                      ParamsType paramsType)

Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom type of request params. It applies for all methods and overrides interface and method level settings.

Type Parameters:

T - interface type

Parameters:

clazz - interface metadata

paramsType - custom type of request params

Returns:

a new proxy

onDemand

public <T> T onDemand(Class<T> clazz,
                      ParamsType paramsType,
                      IdGenerator<?> idGenerator)

Creates a new proxy for accessing a remote JSON-RPC service through an interface with a custom id generator and custom type of request params. The generator overrides the interface generator. The type applies for all methods and overrides interface and method level settings.

Type Parameters:

T - interface type

Parameters:

clazz - interface metadata

idGenerator - custom id generator

paramsType - custom type of request params

Returns:

a new proxy