Package io.openems.common.jsonrpc.base

Class GenericJsonrpcNotification

java.lang.Object

io.openems.common.jsonrpc.base.JsonrpcMessage

io.openems.common.jsonrpc.base.AbstractJsonrpcRequest

io.openems.common.jsonrpc.base.JsonrpcNotification

io.openems.common.jsonrpc.base.GenericJsonrpcNotification

public class GenericJsonrpcNotification
extends JsonrpcNotification

Represents a generic JSON-RPC Notification.

 {
   "jsonrpc": "2.0",
   "method": string,
   "params": {}
 }
 

See Also:

• JSON-RPC specification

Field Summary

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
GenericJsonrpcNotification(String method, com.google.gson.JsonObject params)

Method Summary

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

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

getFullyQualifiedMethod, getMethod, toJsonObject

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

GenericJsonrpcNotification

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

Method Details

from

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

Parses a JSON String to a GenericJsonrpcNotification.

Parameters:

json - the JSON String

Returns:

the GenericJsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

from

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

Parses a JsonObject to a GenericJsonrpcNotification.

Parameters:

j - the JsonObject

Returns:

the GenericJsonrpcNotification

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