Package io.openems.common.jsonrpc.response

Class AuthenticatedRpcResponse

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.JsonrpcResponse

io.openems.common.jsonrpc.base.JsonrpcResponseSuccess

io.openems.common.jsonrpc.response.AuthenticatedRpcResponse

public class AuthenticatedRpcResponse
extends JsonrpcResponseSuccess

Represents a JSON-RPC Response for 'authenticatedRpc'.

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

Field Summary

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
AuthenticatedRpcResponse(UUID id, JsonrpcResponseSuccess payload)

Method Summary

Modifier and Type	Method	Description
static AuthenticatedRpcResponse	from(JsonrpcResponseSuccess r)	Parses a JsonrpcResponseSuccess to a AuthenticatedRpcResponse.
JsonrpcResponseSuccess	getPayload()
com.google.gson.JsonObject	getResult()	Gets the result of this JsonrpcResponseSuccess.

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

from, toJsonObject

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

AuthenticatedRpcResponse

public AuthenticatedRpcResponse(UUID id,
 JsonrpcResponseSuccess payload)

Method Details

from

public static AuthenticatedRpcResponse from(JsonrpcResponseSuccess r)
                                     throws OpenemsError.OpenemsNamedException

Parses a JsonrpcResponseSuccess to a AuthenticatedRpcResponse.

Parameters:

r - the JsonrpcResponseSuccess

Returns:

the AuthenticatedRpcResponse

Throws:

OpenemsError.OpenemsNamedException - on error

getPayload

public JsonrpcResponseSuccess getPayload()

getResult

public com.google.gson.JsonObject getResult()

Description copied from class: JsonrpcResponseSuccess

Gets the result of this JsonrpcResponseSuccess.

Specified by:

getResult in class JsonrpcResponseSuccess

Returns:

a JsonObject with the 'result' property of the response