Package io.openems.backend.core.jsonrpcrequesthandler

Class JsonRpcRequestHandlerImpl

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.core.jsonrpcrequesthandler.JsonRpcRequestHandlerImpl

All Implemented Interfaces:

JsonRpcRequestHandler

public class JsonRpcRequestHandlerImpl
extends AbstractOpenemsBackendComponent
implements JsonRpcRequestHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected io.openems.backend.core.jsonrpcrequesthandler.Config	config
protected EdgeWebsocket	edgeWebsocket
protected Metadata	metadata
protected TimedataManager	timedataManager

Constructor Summary

Constructors

Constructor	Description
JsonRpcRequestHandlerImpl()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<? extends JsonrpcResponseSuccess>	handleRequest(String context, User user, JsonrpcRequest request)	Handles a JSON-RPC Request.
protected void	logError(String context, String message)	Log an error message including the Handler name.
protected void	logInfo(String context, String message)	Log an info message including the Handler name.
protected void	logWarn(String context, String message)	Log a warn message including the Handler name.

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarn, logWarn

Methods inherited from class java.lang.Object

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

Field Details

edgeWebsocket

protected volatile EdgeWebsocket edgeWebsocket

metadata

protected volatile Metadata metadata

timedataManager

protected volatile TimedataManager timedataManager

config

protected io.openems.backend.core.jsonrpcrequesthandler.Config config

Constructor Details

JsonRpcRequestHandlerImpl

public JsonRpcRequestHandlerImpl()

Method Details

handleRequest

public CompletableFuture<? extends JsonrpcResponseSuccess> handleRequest(String context,
 User user,
 JsonrpcRequest request)
                                                                  throws OpenemsError.OpenemsNamedException

Handles a JSON-RPC Request.

Specified by:

handleRequest in interface JsonRpcRequestHandler

Parameters:

context - the Logger context, i.e. the name of the parent source

user - the User

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

logInfo

protected void logInfo(String context,
 String message)

Log an info message including the Handler name.

Parameters:

context - the Logger context, i.e. the name of the parent source

message - the Info-message

logWarn

protected void logWarn(String context,
 String message)

Log a warn message including the Handler name.

Parameters:

context - the Logger context, i.e. the name of the parent source

message - the Warn-message

logError

protected void logError(String context,
 String message)

Log an error message including the Handler name.

Parameters:

context - the Logger context, i.e. the name of the parent source

message - the Error-message