Package io.openems.common.jsonrpc.base
Class JsonrpcResponseError
java.lang.Object
io.openems.common.jsonrpc.base.JsonrpcMessage
io.openems.common.jsonrpc.base.JsonrpcResponse
io.openems.common.jsonrpc.base.JsonrpcResponseError
Represents a JSON-RPC Response Error.
{
"jsonrpc": "2.0",
"id": "UUID",
"error": {
"code": OpenemsError.getCode()
,
"message" string
"data": any[]
}
}
- See Also:
-
Field Summary
Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage
JSONRPC_VERSION
-
Constructor Summary
ConstructorDescriptionJsonrpcResponseError
(UUID id, OpenemsError.OpenemsNamedException exception) JsonrpcResponseError
(UUID id, OpenemsError openemsError, com.google.gson.JsonArray params) JsonrpcResponseError
(UUID id, String message) Creates a generic JSON-RPC Error response. -
Method Summary
Modifier and TypeMethodDescriptionstatic JsonrpcResponseError
from
(com.google.gson.JsonObject j) Parses aJsonObject
to aJsonrpcResponseError
.static JsonrpcResponseError
Parses a JSON String to aJsonrpcResponseError
.com.google.gson.JsonArray
Object[]
Gets the error message parameters as Object array.com.google.gson.JsonObject
Gets theJsonObject
representation of thisJsonrpcMessage
.Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse
getId
Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage
toString
-
Constructor Details
-
JsonrpcResponseError
-
JsonrpcResponseError
Creates a generic JSON-RPC Error response.- Parameters:
id
- the request IDmessage
- the error message
-
JsonrpcResponseError
-
-
Method Details
-
from
Parses a JSON String to aJsonrpcResponseError
.- Parameters:
json
- the JSON String- Returns:
- the
JsonrpcResponseError
- Throws:
OpenemsError.OpenemsNamedException
- on error
-
from
public static JsonrpcResponseError from(com.google.gson.JsonObject j) throws OpenemsError.OpenemsNamedException Parses aJsonObject
to aJsonrpcResponseError
.- Parameters:
j
- theJsonObject
- Returns:
- the
JsonrpcResponseError
- Throws:
OpenemsError.OpenemsNamedException
- on error
-
toJsonObject
public com.google.gson.JsonObject toJsonObject()Description copied from class:JsonrpcMessage
Gets theJsonObject
representation of thisJsonrpcMessage
.- Overrides:
toJsonObject
in classJsonrpcResponse
- Returns:
- a
JsonObject
-
getOpenemsError
-
getParams
public com.google.gson.JsonArray getParams() -
getParamsAsObjectArray
Gets the error message parameters as Object array.- Returns:
- the array of error message parameters
-