Package io.openems.common.jsonrpc.notification

Class SystemLogNotification

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.notification.SystemLogNotification

public class SystemLogNotification
extends JsonrpcNotification

Represents a JSON-RPC Notification for sending the current system log.

 {
   "jsonrpc": "2.0",
   "method": "systemLog",
   "params": {
     "line": SystemLog.toJson()
   }
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METHOD

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

JSONRPC_VERSION

Constructor Summary

Constructors

Constructor	Description
SystemLogNotification(SystemLog line)

Method Summary

Modifier and Type	Method	Description
static SystemLogNotification	from(JsonrpcNotification n)	Parses a JsonrpcNotification to a SystemLogNotification.
static SystemLogNotification	fromPaxLoggingEvent(org.ops4j.pax.logging.spi.PaxLoggingEvent event)	Creates a SystemLogNotification from a PaxLoggingEvent.
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

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

SystemLogNotification

public SystemLogNotification(SystemLog line)

Method Details

from

public static SystemLogNotification from(JsonrpcNotification n)
                                  throws OpenemsError.OpenemsNamedException

Parses a JsonrpcNotification to a SystemLogNotification.

Parameters:

n - the JsonrpcNotification

Returns:

the SystemLogNotification

Throws:

OpenemsError.OpenemsNamedException - on error

fromPaxLoggingEvent

public static SystemLogNotification fromPaxLoggingEvent(org.ops4j.pax.logging.spi.PaxLoggingEvent event)

Creates a SystemLogNotification from a PaxLoggingEvent.

Parameters:

event - the PaxLoggingEvent

Returns:

the SystemLogNotification

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