Package eu.woolplatform.utils.json.rpc

Class JsonRpcRequest

java.lang.Object

eu.woolplatform.utils.json.rpc.JsonRpcMessage

eu.woolplatform.utils.json.rpc.JsonRpcRequest

public class JsonRpcRequest
extends JsonRpcMessage

This class models a JSON-RPC Request.

Method Summary

Modifier and Type	Method	Description
static JsonRpcRequest	create(String method, Object id)	Creates a new JSON-RPC request without parameters.
static JsonRpcRequest	create(String method, List<?> params, Object id)	Creates a new JSON-RPC request with parameters as a JSON array.
static JsonRpcRequest	create(String method, Map<String,?> params, Object id)	Creates a new JSON-RPC request with parameters as a JSON object.
Object	getID()	Returns the request ID (string, number or null).
List<?>	getListParams()	Returns the parameters, if the request contains parameters as a JSON array.
Map<?,?>	getMapParams()	Returns the parameters, if the request contains parameters as a JSON object.
String	getMethod()	Returns the method name.
static JsonRpcRequest	read(Map<?,?> map)	Reads a JSON-RPC request from the specified map, which should represent a JSON object.
String	toString()
void	write(Writer out)	Writes this message as a JSON string to the specified writer.

Methods inherited from class java.lang.Object

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

Method Detail

read

public static JsonRpcRequest read(Map<?,?> map)
                           throws ParseException

Reads a JSON-RPC request from the specified map, which should represent a JSON object.

Parameters:

map - the map

Returns:

the request

Throws:

ParseException - if the map is not a valid JSON-RPC request

See Also:

JsonRpcMessage.read(Map)

create

public static JsonRpcRequest create(String method,
                                    Object id)

Creates a new JSON-RPC request without parameters.

Parameters:

method - the method name

id - the request ID (string, number or null)

Returns:

the request

create

public static JsonRpcRequest create(String method,
                                    Map<String,?> params,
                                    Object id)

Creates a new JSON-RPC request with parameters as a JSON object.

Parameters:

method - the method name

params - the parameters

id - the request ID (string, number or null)

Returns:

the request

create

public static JsonRpcRequest create(String method,
                                    List<?> params,
                                    Object id)

Creates a new JSON-RPC request with parameters as a JSON array.

Parameters:

method - the method name

params - the parameters

id - the request ID (string, number or null)

Returns:

the request

getMethod

public String getMethod()

Returns the method name.

Returns:

the method name

getMapParams

public Map<?,?> getMapParams()

Returns the parameters, if the request contains parameters as a JSON object. If the request has no parameters, or it has parameters as a JSON array, this method returns null.

Returns:

the parameters as a JSON object or null

See Also:

getListParams()

getListParams

public List<?> getListParams()

Returns the parameters, if the request contains parameters as a JSON array. If the request has no parameters, or it has parameters as a JSON object, this method returns null.

Returns:

the parameters as a JSON array or null

See Also:

getMapParams()

getID

public Object getID()

Returns the request ID (string, number or null).

Returns:

the request ID (string, number or null)

write

public void write(Writer out)
           throws IOException

Description copied from class: JsonRpcMessage

Writes this message as a JSON string to the specified writer.

Specified by:

write in class JsonRpcMessage

Parameters:

out - the writer

Throws:

IOException - if a writing error occurs

toString

public String toString()

Overrides:

toString in class JsonRpcMessage