Package io.openems.common.jsonrpc.base

Class JsonrpcRequest

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcRequest

Direct Known Subclasses:

AuthenticatedRpcRequest, AuthenticateWithPasswordRequest, AuthenticateWithTokenRequest, ChannelExportXlsxRequest, ComponentJsonApiRequest, CreateComponentConfigRequest, DeleteComponentConfigRequest, EdgeRpcRequest, ExecuteSimulationRequest, ExecuteSystemCommandRequest, GenericJsonrpcRequest, Get24HoursPredictionRequest, GetDevicesRequest, GetEdgeConfigRequest, GetEdgesChannelsValuesRequest, GetEdgesStatusRequest, GetFieldNamesRequest, GetMetersRequest, GetModbusProtocolExportXlsxRequest, GetModbusProtocolRequest, GetNetworkConfigRequest, LogoutRequest, QueryHistoricTimeseriesDataRequest, QueryHistoricTimeseriesEnergyPerPeriodRequest, QueryHistoricTimeseriesEnergyRequest, QueryHistoricTimeseriesExportXlxsRequest, SetChannelValueRequest, SetGridConnScheduleRequest, SetNetworkConfigRequest, SubscribeChannelsRequest, SubscribeEdgesChannelsRequest, SubscribeSystemLogRequest, UpdateComponentConfigRequest

public abstract class JsonrpcRequest
extends AbstractJsonrpcRequest

Represents a 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

Modifier and Type	Field	Description
static int	DEFAULT_TIMEOUT_SECONDS
static int	NO_TIMEOUT

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

JSONRPC_VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonrpcRequest(JsonrpcRequest request, java.lang.String method)	Creates a JsonrpcRequest by copying and validating header information.
	JsonrpcRequest(java.lang.String method)	Creates a JsonrpcRequest with random UUID as id and DEFAULT_TIMEOUT_SECONDS timeout.
	JsonrpcRequest(java.lang.String method, int timeout)	Creates a JsonrpcRequest with random UUID as id.
	JsonrpcRequest(java.lang.String method, java.util.Optional<java.lang.Integer> timeout)	Creates a JsonrpcRequest with random UUID as id.
	JsonrpcRequest(java.util.UUID id, java.lang.String method, int timeout)	Creates a JsonrpcRequest.
	JsonrpcRequest(java.util.UUID id, java.lang.String method, java.util.Optional<java.lang.Integer> timeout)	Creates a JsonrpcRequest.

Method Summary

Modifier and Type	Method	Description
java.util.UUID	getId()	Gets the JSON-RPC id.
java.util.Optional<java.lang.Integer>	getTimeout()	Gets the max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout.
com.google.gson.JsonObject	toJsonObject()

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

getMethod, getParams

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

from, from, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT_SECONDS

public static final int DEFAULT_TIMEOUT_SECONDS

See Also:

Constant Field Values

NO_TIMEOUT

public static final int NO_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

JsonrpcRequest

public JsonrpcRequest(java.lang.String method)

Creates a JsonrpcRequest with random UUID as id and DEFAULT_TIMEOUT_SECONDS timeout.

Parameters:

method - the JSON-RPC method

JsonrpcRequest

public JsonrpcRequest(java.lang.String method,
                      int timeout)

Creates a JsonrpcRequest with random UUID as id.

Parameters:

method - the JSON-RPC method

timeout - max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout

JsonrpcRequest

public JsonrpcRequest(java.lang.String method,
                      java.util.Optional<java.lang.Integer> timeout)

Creates a JsonrpcRequest with random UUID as id.

Parameters:

method - the JSON-RPC method

timeout - max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout, empty for DEFAULT_TIMEOUT_SECONDS timeout

JsonrpcRequest

public JsonrpcRequest(java.util.UUID id,
                      java.lang.String method,
                      java.util.Optional<java.lang.Integer> timeout)

Creates a JsonrpcRequest.

Parameters:

id - the JSON-RPC id

method - the JSON-RPC method

timeout - max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout, empty for DEFAULT_TIMEOUT_SECONDS timeout

JsonrpcRequest

protected JsonrpcRequest(JsonrpcRequest request,
                         java.lang.String method)

Creates a JsonrpcRequest by copying and validating header information.

• copies id and timeout
• validates that the method names match

Parameters:

request - the template JSON-RPC Request

method - the JSON-RPC method

JsonrpcRequest

public JsonrpcRequest(java.util.UUID id,
                      java.lang.String method,
                      int timeout)

Creates a JsonrpcRequest.

Parameters:

id - the JSON-RPC id

method - the JSON-RPC method

timeout - max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout

Method Detail

getId

public java.util.UUID getId()

Gets the JSON-RPC id.

Returns:

the UUID id

getTimeout

public java.util.Optional<java.lang.Integer> getTimeout()

Gets the max time in seconds to wait for the JsonrpcResponse, negative or zero to disable timeout.

Returns:

the timeout in seconds

toJsonObject

public com.google.gson.JsonObject toJsonObject()

Overrides:

toJsonObject in class AbstractJsonrpcRequest