Package io.openems.edge.controller.api.rest

Class AbstractRestApi

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.controller.api.rest.AbstractRestApi

All Implemented Interfaces:

OpenemsComponent, Controller, RestApi

Direct Known Subclasses:

ControllerApiRestReadOnlyImpl, ControllerApiRestReadWriteImpl

public abstract class AbstractRestApi
extends AbstractOpenemsComponent
implements RestApi, Controller, OpenemsComponent

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.common.component.OpenemsComponent

OpenemsComponent.ChannelId

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

RestApi.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected final ApiWorker	apiWorker
static final boolean	DEFAULT_DEBUG_MODE

Constructor Summary

Constructors

Constructor	Description
AbstractRestApi(String implementationName, ChannelId[] firstInitialChannelIds, ChannelId[]... furtherInitialChannelIds)

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext context, String id, String alias, boolean enabled, boolean isDebugModeEnabled, int apiTimeout, int port, int connectionlimit)	Activate the AbstractRestApi.
protected void	deactivate()	Handles @Deactivate of implementations.
protected abstract AccessMode	getAccessMode()	Gets the AccessMode.
protected abstract ComponentManager	getComponentManager()	Gets the ComponentManager.
protected abstract Timedata	getTimedata()	Gets the Timedata service.
protected abstract UserService	getUserService()	Gets the UserService.
protected boolean	isDebugModeEnabled()
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.

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

Methods inherited from interface io.openems.edge.controller.api.rest.RestApi

_setUnableToStart, getUnableToStart, getUnableToStartChannel

Field Details

DEFAULT_DEBUG_MODE

public static final boolean DEFAULT_DEBUG_MODE

See Also:

• Constant Field Values

apiWorker

protected final ApiWorker apiWorker

Constructor Details

AbstractRestApi

public AbstractRestApi(String implementationName,
 ChannelId[] firstInitialChannelIds,
 ChannelId[]... furtherInitialChannelIds)

Method Details

activate

protected void activate(org.osgi.service.component.ComponentContext context,
 String id,
 String alias,
 boolean enabled,
 boolean isDebugModeEnabled,
 int apiTimeout,
 int port,
 int connectionlimit)

Activate the AbstractRestApi.

Parameters:

context - the ComponentContext

id - the ID

alias - the Alias

enabled - enable component?

isDebugModeEnabled - enable debug mode?

apiTimeout - the API timeout

port - the port; if '0', the port is automatically assigned

connectionlimit - the connection limit

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

isDebugModeEnabled

protected boolean isDebugModeEnabled()

getTimedata

protected abstract Timedata getTimedata()
                                 throws OpenemsException

Gets the Timedata service.

Returns:

the service

Throws:

OpenemsException - if the timeservice is not available

getUserService

protected abstract UserService getUserService()

Gets the UserService.

Returns:

the service

getComponentManager

protected abstract ComponentManager getComponentManager()

Gets the ComponentManager.

Returns:

the service

getAccessMode

protected abstract AccessMode getAccessMode()

Gets the AccessMode.

Returns:

the AccessMode