Package io.openems.common.jsonrpc.base

Class JsonrpcResponseSuccess

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

Direct Known Subclasses:

AddEdgeToUserResponse, AppCenterGetInstalledAppsResponse, AppCenterGetPossibleAppsResponse, AppCenterGetRegisteredKeysResponse, AppCenterIsAppFreeResponse, AppCenterIsKeyApplicableResponse, AuthenticatedRpcResponse, AuthenticateResponse, Base64PayloadResponse, EdgeRpcResponse, ExecuteSimulationResponse, ExecuteSystemCommandResponse, ExecuteSystemRestartResponse, GenericJsonrpcResponseSuccess, GetDeviceResponse, GetEdgeConfigResponse, GetEdgeResponse, GetEdgesChannelsValuesResponse, GetEdgesResponse, GetEdgesStatusResponse, GetFieldNamesResponse, GetMetersResponse, GetModbusProtocolResponse, GetNetworkConfigResponse, GetScheduleResponse, GetSystemUpdateStateResponse, GetUserAlertingConfigsResponse, GetUserInformationResponse, QueryHistoricTimeseriesDataResponse, QueryHistoricTimeseriesEnergyPerPeriodResponse, QueryHistoricTimeseriesEnergyResponse

public abstract class JsonrpcResponseSuccess
extends JsonrpcResponse

Represents a JSON-RPC Success Response.

 {
   "jsonrpc": "2.0",
   "id": "UUID",
   "result": {}
 }
 

See Also:

• JSON-RPC specification

Field Summary

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
JsonrpcResponseSuccess(UUID id)

Method Summary

Modifier and Type	Method	Description
static JsonrpcResponseSuccess	from(com.google.gson.JsonObject j)	Parses the JSON-Object to a JSON-RPC Success Response.
abstract com.google.gson.JsonObject	getResult()	Gets the result of this JsonrpcResponseSuccess.
com.google.gson.JsonObject	toJsonObject()	Gets the JsonObject representation of this JsonrpcMessage.

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

from, 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 Details

JsonrpcResponseSuccess

public JsonrpcResponseSuccess(UUID id)

Method Details

from

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

Parses the JSON-Object to a JSON-RPC Success Response.

Parameters:

j - the JSON-Object

Returns:

the JSON-RPC Success Response

Throws:

OpenemsError.OpenemsNamedException - if it was not a Success Response

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

getResult

public abstract com.google.gson.JsonObject getResult()

Gets the result of this JsonrpcResponseSuccess.

Returns:

a JsonObject with the 'result' property of the response