io.openems.edge.controller.api.websocket

Class WebsocketApi

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.websocket.WebsocketApi

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebsocketApi.ChannelId

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiWorker	apiWorker
protected ComponentManager	componentManager
static int	DEFAULT_PORT
static java.lang.String	EDGE_COMMENT
static java.lang.String	EDGE_ID
static java.lang.String	EDGE_PRODUCT_TYPE
protected WebsocketServer	server
protected java.util.Map<java.util.UUID,EdgeUser>	sessionTokens Stores valid session tokens for authentication via Cookie.
protected UserService	userService

Constructor Summary

Constructors

Constructor and Description
WebsocketApi()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context, io.openems.edge.controller.api.websocket.Config config)
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(java.util.UUID token) Gets the WebSocket connection attachment for a UI token.
void	handleEvent(org.osgi.service.event.Event event)
protected void	handleSubscribeSystemLogRequest(java.util.UUID token, SubscribeSystemLogRequest request) Handles a SubscribeSystemLogRequest by forwarding it to the 'SystemLogHandler'.
protected void	logInfo(org.slf4j.Logger log, java.lang.String message) Log an info message including the Component ID.
protected void	logWarn(org.slf4j.Logger log, java.lang.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, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, logError, 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, getModbusSlaveNatureTable, 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, logDebug, logError, logInfo, logWarn, serviceFactoryPid, servicePid, updateConfigurationProperty, updateReferenceFilter

Field Detail

EDGE_ID

public static final java.lang.String EDGE_ID

See Also:

Constant Field Values

EDGE_COMMENT

public static final java.lang.String EDGE_COMMENT

See Also:

Constant Field Values

EDGE_PRODUCT_TYPE

public static final java.lang.String EDGE_PRODUCT_TYPE

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

apiWorker

protected final ApiWorker apiWorker

server

protected WebsocketServer server

sessionTokens

protected final java.util.Map<java.util.UUID,EdgeUser> sessionTokens

Stores valid session tokens for authentication via Cookie.

componentManager

protected ComponentManager componentManager

userService

protected UserService userService

Constructor Detail

WebsocketApi

public WebsocketApi()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context,
                        io.openems.edge.controller.api.websocket.Config config)

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,
                             java.lang.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,
                             java.lang.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

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(java.util.UUID 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(java.util.UUID 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