Package io.openems.edge.common.jsonapi

Interface JsonApi

All Known Subinterfaces:

AppManager, BalancingSchedule, ComponentManager, Host

All Known Implementing Classes:

AbstractModbusTcpApi, AppManagerImpl, BalancingScheduleImpl, BridgeOnewireImpl, ComponentManagerImpl, DummyComponentManager, DummyHost, HostImpl, MeterDiscovergy, ModbusTcpApiReadOnlyImpl, ModbusTcpApiReadWriteImpl, PredictorManagerImpl, SimulatorApp

public interface JsonApi

Declares a class as being able to handle JSON-RPC Requests.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<? extends JsonrpcResponseSuccess>	handleJsonrpcRequest(User user, JsonrpcRequest request)	Handles a JSON-RPC Request.

Method Detail

handleJsonrpcRequest

java.util.concurrent.CompletableFuture<? extends JsonrpcResponseSuccess> handleJsonrpcRequest(User user,
                                                                                              JsonrpcRequest request)
                                                                                       throws OpenemsError.OpenemsNamedException

Handles a JSON-RPC Request.

Parameters:

user - the authenticated User

request - the JSON-RPC Request

Returns:

a Future JSON-RPC Success Response; null response results in a OpenemsError.JSONRPC_UNHANDLED_METHOD

Throws:

OpenemsError.OpenemsNamedException - on error