com.beowulfchain.beowulfj.communication.jrpc

Class JsonRPCResponse

java.lang.Object

com.beowulfchain.beowulfj.communication.jrpc.JsonRPCResponse

public class JsonRPCResponse
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CALLBACK_METHOD_NAME The method name indicating a callback.
static String	ERROR_CODE_FIELD_NAME The field name of the JSON RPC "code" field.
static String	ERROR_DATA_FIELD_NAME The field name of the JSON RPC "data" field.
static String	ERROR_FIELD_NAME The field name of the JSON RPC "error" field.
static String	ERROR_MESSAGE_FIELD_NAME The field name of the JSON RPC "message" field.
static String	ID_FIELD_NAME The field name of the JSON RPC "id" field.
static String	METHOD_FIELD_NAME The field name of the JSON RPC "method" field.
static String	PARAMETERS_FIELD_NAME The field name of the JSON RPC "method" field.
static String	RESULT_FIELD_NAME The field name of the JSON RPC "result" field.

Constructor Summary

Constructors

Constructor and Description
JsonRPCResponse(com.fasterxml.jackson.databind.JsonNode rawJsonResponse) Create a new JsonRPCResponse instance.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getRawJsonResponse() Get the raw JSON response that is wrapped by this JsonRPCResponse instance.
BeowulfResponseException	handleError(long id) This method checks if the JSON response wrapped by this JsonRPCResponse instance has the expected id and will try to generate and throw a BeowulfResponseException based on the response.
<T> List<T>	handleResult(com.fasterxml.jackson.databind.JavaType type, long id) This method checks if the JSON response wrapped by this JsonRPCResponse instance has the expected id and will try to transform the JSON into the given type.
boolean	isError() Check if the getRawJsonResponse() contains an error.
boolean	isFieldNullOrEmpty(String fieldName, com.fasterxml.jackson.databind.node.ObjectNode response) Check if the given fieldName has an empty or null value.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_FIELD_NAME

public static final String ERROR_FIELD_NAME

The field name of the JSON RPC "error" field.

See Also:

Constant Field Values

ERROR_CODE_FIELD_NAME

public static final String ERROR_CODE_FIELD_NAME

The field name of the JSON RPC "code" field.

See Also:

Constant Field Values

ERROR_MESSAGE_FIELD_NAME

public static final String ERROR_MESSAGE_FIELD_NAME

The field name of the JSON RPC "message" field.

See Also:

Constant Field Values

ERROR_DATA_FIELD_NAME

public static final String ERROR_DATA_FIELD_NAME

The field name of the JSON RPC "data" field.

See Also:

Constant Field Values

METHOD_FIELD_NAME

public static final String METHOD_FIELD_NAME

The field name of the JSON RPC "method" field.

See Also:

Constant Field Values

PARAMETERS_FIELD_NAME

public static final String PARAMETERS_FIELD_NAME

The field name of the JSON RPC "method" field.

See Also:

Constant Field Values

ID_FIELD_NAME

public static final String ID_FIELD_NAME

The field name of the JSON RPC "id" field.

See Also:

Constant Field Values

RESULT_FIELD_NAME

public static final String RESULT_FIELD_NAME

The field name of the JSON RPC "result" field.

See Also:

Constant Field Values

CALLBACK_METHOD_NAME

public static final String CALLBACK_METHOD_NAME

The method name indicating a callback.

See Also:

Constant Field Values

Constructor Detail

JsonRPCResponse

public JsonRPCResponse(com.fasterxml.jackson.databind.JsonNode rawJsonResponse)

Create a new JsonRPCResponse instance.

Parameters:

rawJsonResponse - The raw JSON response that should be wrapped by this JsonRPCResponse instance.

Method Detail

getRawJsonResponse

public com.fasterxml.jackson.databind.JsonNode getRawJsonResponse()

Get the raw JSON response that is wrapped by this JsonRPCResponse instance.

Returns:

The raw JSON response that is wrapped by this JsonRPCResponse instance.

handleResult

public <T> List<T> handleResult(com.fasterxml.jackson.databind.JavaType type,
                                long id)
                         throws BeowulfCommunicationException

This method checks if the JSON response wrapped by this JsonRPCResponse instance has the expected id and will try to transform the JSON into the given type.

Type Parameters:

T - The JavaType of type

Parameters:

type - The type to transform the JSON to.

id - The expected id of the response.

Returns:

A list of of type instances.

Throws:

BeowulfCommunicationException - If the response does not contain the expected id or if the response could not be transformed into the expected type.

isError

public boolean isError()

Check if the getRawJsonResponse() contains an error.

Returns:

true if the response contains an error, false otherwise.

handleError

public BeowulfResponseException handleError(long id)
                                     throws BeowulfCommunicationException

This method checks if the JSON response wrapped by this JsonRPCResponse instance has the expected id and will try to generate and throw a BeowulfResponseException based on the response.

Parameters:

id - The expected id of the response.

Returns:

A BeowulfResponseException based on the Json response.

Throws:

BeowulfCommunicationException - If the response does not contain the expected id or the response do not contain an error.

isFieldNullOrEmpty

public boolean isFieldNullOrEmpty(String fieldName,
                                  com.fasterxml.jackson.databind.node.ObjectNode response)

Check if the given fieldName has an empty or null value.

Parameters:

fieldName - The field name to check.

response - The response to check.

Returns:

true if the fieldName has an empty or null value.

toString

public String toString()

Overrides:

toString in class Object