Package io.openems.edge.controller.api.backend

Class ControllerApiBackendImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.backend.ControllerApiBackendImpl

All Implemented Interfaces:

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

public class ControllerApiBackendImpl
extends AbstractOpenemsComponent
implements ControllerApiBackend, Controller, JsonApi, 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.backend.ControllerApiBackend

ControllerApiBackend.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 static final String	COMPONENT_NAME
protected ComponentManager	componentManager
protected io.openems.edge.controller.api.backend.Config	config
protected Cycle	cycle
protected ResendHistoricDataWorker	resendHistoricDataWorker
protected final SendChannelValuesWorker	sendChannelValuesWorker
protected WebsocketClient	websocket

Constructor Summary

Constructors

Constructor	Description
ControllerApiBackendImpl()

Method Summary

Modifier and Type	Method	Description
protected void	deactivate()	Handles @Deactivate of implementations.
void	doAppend(org.ops4j.pax.logging.spi.PaxLoggingEvent event)
protected void	execute(Runnable command)	Execute a command using the ScheduledExecutorService.
void	handleEvent(org.osgi.service.event.Event event)
CompletableFuture<? extends JsonrpcResponseSuccess>	handleJsonrpcRequest(User user, JsonrpcRequest request)	Handles a JSON-RPC Request.
boolean	isConnected()	Gets if the edge is currently connected to the backend.
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	run()	Executes the Controller logic.
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)	Schedules a command using the ScheduledExecutorService.
protected void	setSystemLogSubscribed(boolean isSystemLogSubscribed)	Activates/deactivates subscription to System-Log.

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.controller.api.backend.ControllerApiBackend

getApiWorkerLogChannel, getLastSuccessFulResendChannel, getUnableToSendChannel

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

COMPONENT_NAME

protected static final String COMPONENT_NAME

See Also:

• Constant Field Values

sendChannelValuesWorker

protected final SendChannelValuesWorker sendChannelValuesWorker

apiWorker

protected final ApiWorker apiWorker

resendHistoricDataWorker

protected ResendHistoricDataWorker resendHistoricDataWorker

componentManager

protected ComponentManager componentManager

cycle

protected Cycle cycle

websocket

protected WebsocketClient websocket

config

protected io.openems.edge.controller.api.backend.Config config

Constructor Details

ControllerApiBackendImpl

public ControllerApiBackendImpl()

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

setSystemLogSubscribed

protected void setSystemLogSubscribed(boolean isSystemLogSubscribed)

Activates/deactivates subscription to System-Log.

If activated, all System-Log events are sent via SystemLogNotifications.

Parameters:

isSystemLogSubscribed - true to activate

doAppend

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

Specified by:

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

handleEvent

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

Specified by:

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

isConnected

public boolean isConnected()

Description copied from interface: ControllerApiBackend

Gets if the edge is currently connected to the backend.

Specified by:

isConnected in interface ControllerApiBackend

Returns:

true if it is connected

execute

protected void execute(Runnable command)

Execute a command using the ScheduledExecutorService.

Parameters:

command - a Runnable

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
 long initialDelay,
 long delay,
 TimeUnit unit)

Schedules a command using the ScheduledExecutorService.

Parameters:

command - a Runnable

initialDelay - the initial delay

delay - the delay

unit - the TimeUnit

Returns:

a ScheduledFuture, or null if Executor is shutting down

handleJsonrpcRequest

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

Description copied from interface: JsonApi

Handles a JSON-RPC Request.

Specified by:

handleJsonrpcRequest in interface JsonApi

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