Package io.openems.common.jsonrpc.request

Class EdgeRpcRequest

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.request.EdgeRpcRequest

public class EdgeRpcRequest
extends JsonrpcRequest

Wraps a JSON-RPC Request for a specific Edge-ID.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "method": "edgeRpc",
   "params": {
     "edgeId": string,
     "payload": {
     }
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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
EdgeRpcRequest(JsonrpcRequest request, String edgeId, JsonrpcRequest payload)
EdgeRpcRequest(String edgeId, JsonrpcRequest payload)

Method Summary

Modifier and Type	Method	Description
static EdgeRpcRequest	from(JsonrpcRequest r)	Create EdgeRpcRequest from a template JsonrpcRequest.
String	getEdgeId()	Gets the Edge-ID.
com.google.gson.JsonObject	getParams()	Gets the params JsonObject of the JsonrpcRequest.
JsonrpcRequest	getPayload()	Gets the Payload 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

from, from, toString

Methods inherited from class java.lang.Object

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

Field Details

METHOD

public static final String METHOD

See Also:

• Constant Field Values

Constructor Details

EdgeRpcRequest

public EdgeRpcRequest(String edgeId,
 JsonrpcRequest payload)

EdgeRpcRequest

public EdgeRpcRequest(JsonrpcRequest request,
 String edgeId,
 JsonrpcRequest payload)

Method Details

from

public static EdgeRpcRequest from(JsonrpcRequest r)
                           throws OpenemsError.OpenemsNamedException

Create EdgeRpcRequest from a template JsonrpcRequest.

Parameters:

r - the template JsonrpcRequest

Returns:

the EdgeRpcRequest

Throws:

OpenemsError.OpenemsNamedException - on parse error

getEdgeId

public String getEdgeId()

Gets the Edge-ID.

Returns:

Edge-ID

getPayload

public JsonrpcRequest getPayload()

Gets the Payload JsonrpcRequest.

Returns:

Payload

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