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

public class JsonrpcResponseError
extends JsonrpcResponse

Represents a JSON-RPC Response Error.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "error": {
     "code": OpenemsError.getCode(),
     "message" string
     "data": any[]
   }
 }
 

See Also:

JSON-RPC specification

Field Summary

Fields inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
JsonrpcResponseError(java.util.UUID id, OpenemsError.OpenemsNamedException exception)
JsonrpcResponseError(java.util.UUID id, OpenemsError openemsError, com.google.gson.JsonArray params)
JsonrpcResponseError(java.util.UUID id, java.lang.String message)	Creates a generic JSON-RPC Error response.

Method Summary

Modifier and Type	Method	Description
static JsonrpcResponseError	from(com.google.gson.JsonObject j)	Parses a JsonObject to a JsonrpcResponseError.
static JsonrpcResponseError	from(java.lang.String json)	Parses a JSON String to a JsonrpcResponseError.
OpenemsError	getOpenemsError()
com.google.gson.JsonArray	getParams()
java.lang.Object[]	getParamsAsObjectArray()	Gets the error message parameters as Object array.
com.google.gson.JsonObject	toJsonObject()	Gets the JsonObject representation of this JsonrpcMessage.

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcResponse

getId

Methods inherited from class io.openems.common.jsonrpc.base.JsonrpcMessage

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonrpcResponseError

public JsonrpcResponseError(java.util.UUID id,
                            OpenemsError openemsError,
                            com.google.gson.JsonArray params)

JsonrpcResponseError

public JsonrpcResponseError(java.util.UUID id,
                            java.lang.String message)

Creates a generic JSON-RPC Error response.

Parameters:

id - the request ID

message - the error message

JsonrpcResponseError

public JsonrpcResponseError(java.util.UUID id,
                            OpenemsError.OpenemsNamedException exception)

Method Detail

from

public static JsonrpcResponseError from(java.lang.String json)
                                 throws OpenemsError.OpenemsNamedException

Parses a JSON String to a JsonrpcResponseError.

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 a JsonObject to a JsonrpcResponseError.

Parameters:

j - the JsonObject

Returns:

the JsonrpcResponseError

Throws:

OpenemsError.OpenemsNamedException - on error

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Description copied from class: JsonrpcMessage

Gets the JsonObject representation of this JsonrpcMessage.

Overrides:

toJsonObject in class JsonrpcResponse

Returns:

a JsonObject

getOpenemsError

public OpenemsError getOpenemsError()

getParams

public com.google.gson.JsonArray getParams()

getParamsAsObjectArray

public java.lang.Object[] getParamsAsObjectArray()

Gets the error message parameters as Object array.

Returns:

the array of error message parameters