public class JSONRPC2Error extends Exception
The protocol expects error objects to be structured like this:
code
An integer that indicates the error type.
message
A string providing a short description of the
error. The message should be limited to a concise single sentence.
data
Additional information, which may be omitted. Its
contents is entirely defined by the application.
Note that the "Error" word in the class name was put there solely to
comply with the parlance of the JSON-RPC spec. This class doesn't inherit
from java.lang.Error
. It's a regular subclass of
java.lang.Exception
and, if thrown, it's to indicate a condition
that a reasonable application might want to catch.
This class also includes convenient final static instances for all standard JSON-RPC 2.0 errors:
PARSE_ERROR
JSON parse error (-32700)
INVALID_REQUEST
Invalid JSON-RPC 2.0 Request (-32600)
METHOD_NOT_FOUND
Method not found (-32601)
INVALID_PARAMS
Invalid parameters (-32602)
INTERNAL_ERROR
Internal error (-32603)
Note that the range -32099..-32000 is reserved for additional server errors.
The mapping between JSON and Java entities (as defined by the underlying JSON Smart library):
true|false <---> java.lang.Boolean number <---> java.lang.Number string <---> java.lang.String array <---> java.util.List object <---> java.util.Map null <---> null
Modifier and Type | Field and Description |
---|---|
static JSONRPC2Error |
INTERNAL_ERROR
Internal JSON-RPC 2.0 error (-32603).
|
static JSONRPC2Error |
INVALID_PARAMS
Invalid parameters error (-32602).
|
static JSONRPC2Error |
INVALID_REQUEST
Invalid JSON-RPC 2.0 request error (-32600).
|
static JSONRPC2Error |
METHOD_NOT_FOUND
Method not found error (-32601).
|
static JSONRPC2Error |
PARSE_ERROR
JSON parse error (-32700).
|
Constructor and Description |
---|
JSONRPC2Error(int code,
String message)
Creates a new JSON-RPC 2.0 error with the specified code and
message.
|
JSONRPC2Error(int code,
String message,
Object data)
Creates a new JSON-RPC 2.0 error with the specified code,
message and data.
|
Modifier and Type | Method and Description |
---|---|
static JSONRPC2Error |
appendMessage(JSONRPC2Error err,
String apx)
Deprecated.
|
JSONRPC2Error |
appendMessage(String apx)
Appends the specified string to the message of this JSON-RPC 2.0
error.
|
boolean |
equals(Object object)
Overrides
Object.equals() . |
int |
getCode()
Gets the JSON-RPC 2.0 error code.
|
Object |
getData()
Gets the JSON-RPC 2.0 error data.
|
static JSONRPC2Error |
setData(JSONRPC2Error err,
Object data)
Deprecated.
|
JSONRPC2Error |
setData(Object data)
Sets the specified data to a JSON-RPC 2.0 error.
|
net.minidev.json.JSONObject |
toJSON()
Deprecated.
|
net.minidev.json.JSONObject |
toJSONObject()
Returns a JSON object representation of this JSON-RPC 2.0 error.
|
String |
toString()
Serialises the error object to a JSON string.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
public static final JSONRPC2Error PARSE_ERROR
public static final JSONRPC2Error INVALID_REQUEST
public static final JSONRPC2Error METHOD_NOT_FOUND
public static final JSONRPC2Error INVALID_PARAMS
public static final JSONRPC2Error INTERNAL_ERROR
public JSONRPC2Error(int code, String message)
code
- The error code (standard pre-defined or
application-specific).message
- The error message.public JSONRPC2Error(int code, String message, Object data)
code
- The error code (standard pre-defined or
application-specific).message
- The error message.data
- Optional error data, must map
to a valid JSON type.@Deprecated public static JSONRPC2Error appendMessage(JSONRPC2Error err, String apx)
err
- The JSON-RPC 2.0 error. Must not be null
.apx
- The string to append to the original error message.@Deprecated public static JSONRPC2Error setData(JSONRPC2Error err, Object data)
err
- The JSON-RPC 2.0 error to have its data field set. Must
not be null
.data
- Optional error data, must map to a
valid JSON type.public int getCode()
public Object getData()
null
if none was specified.public JSONRPC2Error setData(Object data)
data
- Optional error data, must map to a
valid JSON type.public JSONRPC2Error appendMessage(String apx)
apx
- The string to append to the original error message.@Deprecated public net.minidev.json.JSONObject toJSON()
toJSONObject()
public net.minidev.json.JSONObject toJSONObject()
Copyright © 2015 The Transaction Company. All Rights Reserved.