Package io.openems.edge.controller.api.websocket

Class ControllerApiWebsocketImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.websocket.ControllerApiWebsocketImpl

All Implemented Interfaces:

OpenemsComponent, Controller, ControllerApiWebsocket, org.ops4j.pax.logging.spi.PaxAppender, org.osgi.service.event.EventHandler

public class ControllerApiWebsocketImpl
extends AbstractOpenemsComponent
implements ControllerApiWebsocket, Controller, OpenemsComponent, org.ops4j.pax.logging.spi.PaxAppender, org.osgi.service.event.EventHandler

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.Controller

Controller.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.controller.api.websocket.ControllerApiWebsocket

ControllerApiWebsocket.ChannelId

Nested classes/interfaces inherited from interface io.openems.edge.common.component.OpenemsComponent

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected final ApiWorker	apiWorker
protected ComponentManager	componentManager
protected WebsocketServer	server
protected final Map<String,User>	sessionTokens	Stores valid session tokens for authentication via Cookie.
protected UserService	userService

Fields inherited from interface io.openems.edge.controller.api.websocket.ControllerApiWebsocket

DEFAULT_PORT, EDGE_COMMENT, EDGE_ID, EDGE_PRODUCT_TYPE, SUM_STATE

Constructor Summary

Constructors

Constructor	Description
ControllerApiWebsocketImpl()

Method Summary

Modifier and Type	Method	Description
protected void	deactivate()	Handles @Deactivate of implementations.
void	doAppend(org.ops4j.pax.logging.spi.PaxLoggingEvent event)
Timedata	getTimedata()	Gets the Timedata service.
protected WsData	getWsDataForTokenOrError(String token)	Gets the WebSocket connection attachment for a UI token.
void	handleEvent(org.osgi.service.event.Event event)
protected void	handleSubscribeSystemLogRequest(String token, SubscribeSystemLogRequest request)	Handles a SubscribeSystemLogRequest by forwarding it to the 'SystemLogHandler'.
protected void	logError(org.slf4j.Logger log, String message)	Log an error message including the Component ID.
protected final void	logInfo(org.slf4j.Logger log, String message)	Log an info message including the Component ID.
protected final void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
void	run()	Executes the Controller logic.

Methods inherited from class io.openems.edge.common.component.AbstractOpenemsComponent

_channel, activate, activate, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, modified, removeChannel

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.controller.api.Controller

_setRunFailed, getRunFailed, getRunFailedChannel

Methods inherited from interface io.openems.edge.common.component.OpenemsComponent

_channel, _getChannelAs, alias, channel, channel, channels, debugLog, getComponentContext, getState, getStateChannel, hasFaults, id, isEnabled, serviceFactoryPid, servicePid

Field Details

sessionTokens

protected final Map<String,User> sessionTokens

Stores valid session tokens for authentication via Cookie.

apiWorker

protected final ApiWorker apiWorker

componentManager

protected ComponentManager componentManager

userService

protected UserService userService

server

protected WebsocketServer server

Constructor Details

ControllerApiWebsocketImpl

public ControllerApiWebsocketImpl()

Method Details

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

run

public void run()
         throws OpenemsError.OpenemsNamedException

Description copied from interface: Controller

Executes the Controller logic.

Specified by:

run in interface Controller

Throws:

OpenemsError.OpenemsNamedException - on error

logInfo

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

Description copied from class: AbstractOpenemsComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

logWarn

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

Description copied from class: AbstractOpenemsComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

logError

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

Description copied from class: AbstractOpenemsComponent

Log an error message including the Component ID.

Overrides:

logError in class AbstractOpenemsComponent

Parameters:

log - the Logger instance

message - the message

doAppend

public void doAppend(org.ops4j.pax.logging.spi.PaxLoggingEvent event)

Specified by:

doAppend in interface org.ops4j.pax.logging.spi.PaxAppender

getWsDataForTokenOrError

protected WsData getWsDataForTokenOrError(String token)
                                   throws OpenemsError.OpenemsNamedException

Gets the WebSocket connection attachment for a UI token.

Parameters:

token - the UI token

Returns:

the WsData

Throws:

OpenemsError.OpenemsNamedException - if there is no connection with this token

handleSubscribeSystemLogRequest

protected void handleSubscribeSystemLogRequest(String token,
 SubscribeSystemLogRequest request)
                                        throws OpenemsError.OpenemsNamedException

Handles a SubscribeSystemLogRequest by forwarding it to the 'SystemLogHandler'.

Parameters:

token - the UI token

request - the SubscribeSystemLogRequest

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

getTimedata

public Timedata getTimedata()
                     throws OpenemsException

Gets the Timedata service.

Returns:

the service

Throws:

OpenemsException - if the timeservice is not available