Package org.consensusj.jsonrpc

Class JsonRpcRequest

java.lang.Object

org.consensusj.jsonrpc.JsonRpcRequest

public class JsonRpcRequest
extends Object

JSON-RPC Request POJO

Constructor Summary

Constructors

Constructor	Description
JsonRpcRequest(String method)	Convenience constructor for requests with empty parameter list
JsonRpcRequest(String jsonrpc, String id, String method, List<Object> params)	Constructor for use by Jackson deserialization.
JsonRpcRequest(String method, List<?> params)	Create a JSON RPC request (for serialization.) To create a request on the client side, it is generally recommended to use the methods in JsonRpcClient.
JsonRpcRequest(JsonRpcMessage.Version jsonRpcVersion, long id, String method, List<Object> params)	This constructor is slightly more strict than the deserialization constructor and should be used where possible.
JsonRpcRequest(JsonRpcMessage.Version jsonRpcVersion, String method, List<?> params)	Create a JSON RPC request (for serialization.) Can be used to override default JSON RPC version.

Method Summary

Modifier and Type	Method	Description
String	getId()
String	getJsonrpc()
String	getMethod()
List<Object>	getParams()

Methods inherited from class java.lang.Object

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

Constructor Details

JsonRpcRequest

public JsonRpcRequest(String jsonrpc,
 String id,
 String method,
 List<Object> params)

Constructor for use by Jackson deserialization. Deserialization will typically be used on the server-side. To create a request on the client side, it is generally recommended to use the methods in JsonRpcClient.

Parameters:

jsonrpc - filled from the JSON object

id - filled from the JSON object

method - filled from the JSON object

params - filled from the JSON object

See Also:

• JsonRpcClient.buildJsonRequest(String, List)
• JsonRpcClient.buildJsonRequest(String, Object...)

JsonRpcRequest

public JsonRpcRequest(JsonRpcMessage.Version jsonRpcVersion,
 long id,
 String method,
 List<Object> params)

This constructor is slightly more strict than the deserialization constructor and should be used where possible. It uses the JsonRpcMessage.Version enum and requires that the id be a long.

Parameters:

jsonRpcVersion - JSON-RPC version (enum)

id - message id

method - RPC method

params - RPC method positional parameters

JsonRpcRequest

public JsonRpcRequest(JsonRpcMessage.Version jsonRpcVersion,
 String method,
 List<?> params)

Create a JSON RPC request (for serialization.) Can be used to override default JSON RPC version. To create a request on the client side, it is generally recommended to use the methods in the JsonRpcClient you are using.

Parameters:

jsonRpcVersion - JSON-RPC version (enum)

method - Method of remote procedure to call

params - Parameters to serialize

JsonRpcRequest

public JsonRpcRequest(String method,
 List<?> params)

Create a JSON RPC request (for serialization.) To create a request on the client side, it is generally recommended to use the methods in JsonRpcClient.

Parameters:

method - Method of remote procedure to call

params - Parameters to serialize

See Also:

• JsonRpcClient.buildJsonRequest(String, List)
• JsonRpcClient.buildJsonRequest(String, Object...)

JsonRpcRequest

public JsonRpcRequest(String method)

Convenience constructor for requests with empty parameter list

Parameters:

method - method name string

Method Details

getJsonrpc

public String getJsonrpc()

getMethod

public String getMethod()

getId

public String getId()

getParams

public List<Object> getParams()