Package eu.woolplatform.utils.json.rpc

Class JsonRpcResponse

java.lang.Object

eu.woolplatform.utils.json.rpc.JsonRpcMessage

eu.woolplatform.utils.json.rpc.JsonRpcResponse

public class JsonRpcResponse
extends JsonRpcMessage

This class models a JSON-RPC Response.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonRpcResponse.Error	An error in a response message.

Method Summary

Modifier and Type	Method	Description
static JsonRpcResponse	createError(JsonRpcResponse.Error error, Object id)	Creates a JSON-RPC response with an error.
static JsonRpcResponse	createResult(Object result, Object id)	Creates a JSON-RPC response with a result.
JsonRpcResponse.Error	getError()	Returns the error, if this response contains an error.
Object	getID()	Returns the request ID (string, number or null).
Object	getResult()	Returns the result.
static JsonRpcResponse	read(Map<?,?> map)	Reads a JSON-RPC response 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 JsonRpcResponse read(Map<?,?> map)
                            throws ParseException

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

Parameters:

map - the map

Returns:

the response

Throws:

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

See Also:

JsonRpcMessage.read(Map)

createResult

public static JsonRpcResponse createResult(Object result,
                                           Object id)

Creates a JSON-RPC response with a result.

Parameters:

result - the result

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

Returns:

the response

createError

public static JsonRpcResponse createError(JsonRpcResponse.Error error,
                                          Object id)

Creates a JSON-RPC response with an error.

Parameters:

error - the error

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

Returns:

the response

getResult

public Object getResult()

Returns the result. If this response doesn't contain a result, this method returns null and getError() should return an error.

Returns:

the result or null

getError

public JsonRpcResponse.Error getError()

Returns the error, if this response contains an error. Otherwise it returns null and getResult() should return a result.

Returns:

the error or null

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