Package io.openems.common.jsonrpc.base

Class GenericJsonrpcRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

io.openems.common.jsonrpc.base.GenericJsonrpcRequest

public class GenericJsonrpcRequest
extends JsonrpcRequest

Represents a generic JSON-RPC Request.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": string,
   "params": {},
   "timeout"?: number, defaults to 60 seconds; negative or zero to disable timeout
 }
 

See Also:

• JSON-RPC specification

Field Summary

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

DEFAULT_TIMEOUT_SECONDS, id, NO_TIMEOUT, timeoutOpt

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
GenericJsonrpcRequest(String method, com.google.gson.JsonObject params)
GenericJsonrpcRequest(UUID id, String method, com.google.gson.JsonObject params, int timeout)
GenericJsonrpcRequest(UUID id, String method, com.google.gson.JsonObject params, Optional<Integer> timeoutOpt)

Method Summary

Modifier and Type	Method	Description
static GenericJsonrpcRequest	from(com.google.gson.JsonObject j)	Parses the JsonObject to a GenericJsonrpcRequest.
static GenericJsonrpcRequest	from(String json)	Parses the String to a GenericJsonrpcRequest.
static GenericJsonrpcRequest	fromIgnoreId(com.google.gson.JsonObject j)	Parses the JsonObject to a GenericJsonrpcRequest.
static GenericJsonrpcRequest	fromIgnoreId(String json)	Parses the String to a GenericJsonrpcRequest.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.

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

getId, getTimeout, toJsonObject

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

getFullyQualifiedMethod, getMethod

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 Details

GenericJsonrpcRequest

public GenericJsonrpcRequest(UUID id,
 String method,
 com.google.gson.JsonObject params,
 int timeout)

GenericJsonrpcRequest

public GenericJsonrpcRequest(UUID id,
 String method,
 com.google.gson.JsonObject params,
 Optional<Integer> timeoutOpt)

GenericJsonrpcRequest

public GenericJsonrpcRequest(String method,
 com.google.gson.JsonObject params)

Method Details

from

public static GenericJsonrpcRequest from(String json)
                                  throws OpenemsError.OpenemsNamedException

Parses the String to a GenericJsonrpcRequest.

Parameters:

json - the String

Returns:

the GenericJsonrpcRequest

Throws:

OpenemsError.OpenemsNamedException - on error

from

public static GenericJsonrpcRequest from(com.google.gson.JsonObject j)
                                  throws OpenemsError.OpenemsNamedException

Parses the JsonObject to a GenericJsonrpcRequest.

Parameters:

j - the JsonObject

Returns:

the GenericJsonrpcRequest

Throws:

OpenemsError.OpenemsNamedException - on error

fromIgnoreId

public static GenericJsonrpcRequest fromIgnoreId(String json)
                                          throws OpenemsError.OpenemsNamedException

Parses the String to a GenericJsonrpcRequest. If the request UUID is missing, it is replaced by a random UUID.

Parameters:

json - the String

Returns:

the GenericJsonrpcRequest

Throws:

OpenemsError.OpenemsNamedException - on error

fromIgnoreId

public static GenericJsonrpcRequest fromIgnoreId(com.google.gson.JsonObject j)
                                          throws OpenemsError.OpenemsNamedException

Parses the JsonObject to a GenericJsonrpcRequest. If the request UUID is missing, it is replaced by a random UUID.

Parameters:

j - the JsonObject

Returns:

the GenericJsonrpcRequest

Throws:

OpenemsError.OpenemsNamedException - on error

getParams

public com.google.gson.JsonObject getParams()

Description copied from class: AbstractJsonrpcRequest

Gets the params JsonObject of the JsonrpcRequest.

Specified by:

getParams in class AbstractJsonrpcRequest

Returns:

the params as JsonObject