Package io.openems.backend.edgewebsocket

Class EdgeWebsocketImpl

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.edgewebsocket.EdgeWebsocketImpl

All Implemented Interfaces:

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

public class EdgeWebsocketImpl
extends AbstractOpenemsBackendComponent
implements EdgeWebsocket, org.osgi.service.event.EventHandler, DebugLoggable

Field Summary

Fields

Modifier and Type	Field	Description
protected AppCenterMetadata.EdgeData	appCenterMetadata
protected org.osgi.service.event.EventAdmin	eventAdmin
protected Metadata	metadata
protected TimedataManager	timedataManager
protected UiWebsocket	uiWebsocket

Constructor Summary

Constructors

Constructor	Description
EdgeWebsocketImpl()

Method Summary

Modifier and Type	Method	Description
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.
SortedMap<ChannelAddress,com.google.gson.JsonElement>	getChannelValues(String edgeId, Set<ChannelAddress> channelAddresses)	Gets the latest values for the given ChannelAddresses.
String	getId()
void	handleEvent(org.osgi.service.event.Event event)
CompletableFuture<JsonrpcResponseSuccess>	handleSubscribeSystemLogRequest(String edgeId, User user, UUID websocketId, SubscribeSystemLogRequest request)	Handles a SubscribeSystemLogRequest.
void	handleSystemLogNotification(String edgeId, SystemLogNotification notification)	Handles a SystemLogNotification, i.e.
protected boolean	isOnline(String edgeId)	Gets whether the Websocket for this Edge is connected.
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	logInfo(org.slf4j.Logger log, String edgeId, String message)	Logs a info message with Edge-ID.
protected void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, String edgeId, String message)	Logs a warning message with Edge-ID.
CompletableFuture<JsonrpcResponseSuccess>	send(String edgeId, User user, JsonrpcRequest request)	Send an authenticated JSON-RPC Request to an Edge via Websocket and expect a JSON-RPC Response.
void	send(String edgeId, JsonrpcNotification notification)	Send a JSON-RPC Notification to an Edge.

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

metadata

protected volatile Metadata metadata

appCenterMetadata

protected volatile AppCenterMetadata.EdgeData appCenterMetadata

timedataManager

protected volatile TimedataManager timedataManager

eventAdmin

protected volatile org.osgi.service.event.EventAdmin eventAdmin

uiWebsocket

protected volatile UiWebsocket uiWebsocket

Constructor Details

EdgeWebsocketImpl

public EdgeWebsocketImpl()

Method Details

isOnline

protected boolean isOnline(String edgeId)

Gets whether the Websocket for this Edge is connected.

Parameters:

edgeId - the Edge-ID

Returns:

true if it is online

send

public CompletableFuture<JsonrpcResponseSuccess> send(String edgeId,
 User user,
 JsonrpcRequest request)
                                               throws OpenemsError.OpenemsNamedException

Description copied from interface: EdgeWebsocket

Send an authenticated JSON-RPC Request to an Edge via Websocket and expect a JSON-RPC Response.

Specified by:

send in interface EdgeWebsocket

Parameters:

edgeId - the Edge-ID

user - the authenticated User

request - the JsonrpcRequest

Returns:

the JSON-RPC Success Response Future

Throws:

OpenemsError.OpenemsNamedException - on error

send

public void send(String edgeId,
 JsonrpcNotification notification)
          throws OpenemsException

Description copied from interface: EdgeWebsocket

Send a JSON-RPC Notification to an Edge.

Specified by:

send in interface EdgeWebsocket

Parameters:

edgeId - the Edge-ID

notification - the JsonrpcNotification

Throws:

OpenemsException

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

logInfo

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

Logs a info message with Edge-ID.

Parameters:

log - the Logger

edgeId - the Edge-ID

message - the 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

logWarn

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

Logs a warning message with Edge-ID.

Parameters:

log - the Logger

edgeId - the Edge-ID

message - the 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

handleSubscribeSystemLogRequest

public CompletableFuture<JsonrpcResponseSuccess> handleSubscribeSystemLogRequest(String edgeId,
 User user,
 UUID websocketId,
 SubscribeSystemLogRequest request)
                                                                          throws OpenemsError.OpenemsNamedException

Description copied from interface: EdgeWebsocket

Handles a SubscribeSystemLogRequest.

Specified by:

handleSubscribeSystemLogRequest in interface EdgeWebsocket

Parameters:

edgeId - the Edge-ID

user - the User

websocketId - the id of the UI websocket connection

request - the SubscribeSystemLogRequest

Returns:

a reply

Throws:

OpenemsError.OpenemsNamedException - on error

handleSystemLogNotification

public void handleSystemLogNotification(String edgeId,
 SystemLogNotification notification)

Handles a SystemLogNotification, i.e. the replies to SubscribeSystemLogRequest.

Parameters:

edgeId - the Edge-ID

notification - the SystemLogNotification

handleEvent

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

Specified by:

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

getChannelValues

public SortedMap<ChannelAddress,com.google.gson.JsonElement> getChannelValues(String edgeId,
 Set<ChannelAddress> channelAddresses)

Description copied from interface: EdgeWebsocket

Gets the latest values for the given ChannelAddresses.

Specified by:

getChannelValues in interface EdgeWebsocket

Parameters:

edgeId - The unique Edge-ID

channelAddresses - The ChannelAddresses

Returns:

the values; possibly JsonNull

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