Package io.openems.backend.uiwebsocket.impl

Class UiWebsocketImpl

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.uiwebsocket.impl.UiWebsocketImpl

All Implemented Interfaces:

DebugLoggable, UiWebsocket, org.osgi.service.event.EventHandler

public class UiWebsocketImpl
extends AbstractOpenemsBackendComponent
implements UiWebsocket, org.osgi.service.event.EventHandler, DebugLoggable

Field Summary

Fields

Modifier and Type	Field	Description
protected EdgeWebsocket	edgeWebsocket
protected JsonRpcRequestHandler	jsonRpcRequestHandler
protected Metadata	metadata
protected WebsocketServer	server
protected TimedataManager	timedataManager

Constructor Summary

Constructors

Constructor	Description
UiWebsocketImpl()

Method Summary

Modifier and Type	Method	Description
protected User	assertUser(WsData wsData, AbstractJsonrpcRequest request)	Gets the authenticated User or throws an Exception if User is not authenticated.
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
Map<String,com.google.gson.JsonElement>	debugMetrics()	Gets some output that is suitable for a debug metrics to write down as Timedata.
String	getId()
void	handleEvent(org.osgi.service.event.Event event)
protected void	logError(org.slf4j.Logger log, String message)	Log an error message including the Component ID.
protected void	logInfo(org.slf4j.Logger log, String message)	Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
void	send(UUID websocketId, JsonrpcNotification notification)	Send a JSON-RPC Notification to a UI session.
CompletableFuture<JsonrpcResponseSuccess>	send(UUID websocketId, JsonrpcRequest request)	Send a JSON-RPC Request to a UI session via WebSocket and expect a JSON-RPC Response.
void	sendBroadcast(String edgeId, JsonrpcNotification notification)	Send a JSON-RPC Notification broadcast to all UI sessions with a given Edge-ID.
void	sendSubscribedChannels(String edgeId, EdgeCache edgeCache)	Sends the subscribed Channels to the UI session.

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

getName, logDebug, logDebug, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

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

Field Details

server

protected WebsocketServer server

jsonRpcRequestHandler

protected volatile JsonRpcRequestHandler jsonRpcRequestHandler

metadata

protected volatile Metadata metadata

edgeWebsocket

protected volatile EdgeWebsocket edgeWebsocket

timedataManager

protected volatile TimedataManager timedataManager

Constructor Details

UiWebsocketImpl

public UiWebsocketImpl()

Method Details

logInfo

protected void logInfo(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Info-message

logWarn

protected void logWarn(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Warn-message

logError

protected void logError(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an error message including the Component ID.

Overrides:

logError in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Error-message

send

public void send(UUID websocketId,
 JsonrpcNotification notification)
          throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Notification to a UI session.

Specified by:

send in interface UiWebsocket

Parameters:

websocketId - the id of the UI websocket connection

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

send

public CompletableFuture<JsonrpcResponseSuccess> send(UUID websocketId,
 JsonrpcRequest request)
                                               throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Request to a UI session via WebSocket and expect a JSON-RPC Response.

Specified by:

send in interface UiWebsocket

Parameters:

websocketId - the id of the UI websocket connection

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

sendBroadcast

public void sendBroadcast(String edgeId,
 JsonrpcNotification notification)
                   throws OpenemsError.OpenemsNamedException

Description copied from interface: UiWebsocket

Send a JSON-RPC Notification broadcast to all UI sessions with a given Edge-ID.

Specified by:

sendBroadcast in interface UiWebsocket

Parameters:

edgeId - the Edge-ID

notification - the JsonrpcNotification

Throws:

OpenemsError.OpenemsNamedException - on error

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

sendSubscribedChannels

public void sendSubscribedChannels(String edgeId,
 EdgeCache edgeCache)

Description copied from interface: UiWebsocket

Sends the subscribed Channels to the UI session.

Specified by:

sendSubscribedChannels in interface UiWebsocket

Parameters:

edgeId - the Edge-ID

edgeCache - the EdgeCache for the Edge-ID

assertUser

protected User assertUser(WsData wsData,
 AbstractJsonrpcRequest request)
                   throws OpenemsError.OpenemsNamedException

Gets the authenticated User or throws an Exception if User is not authenticated.

Parameters:

wsData - the WebSocket attachment

request - the AbstractJsonrpcRequest

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - if User is not authenticated

getId

public String getId()

debugLog

public String debugLog()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a continuous Debug log.

Specified by:

debugLog in interface DebugLoggable

Returns:

the debug log output; null for no log

debugMetrics

public Map<String,com.google.gson.JsonElement> debugMetrics()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a debug metrics to write down as Timedata.

Specified by:

debugMetrics in interface DebugLoggable

Returns:

the key value entries to write down; null or emptyMap for no metrics