Package io.openems.edge.core.componentmanager

Class ComponentManagerImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.core.componentmanager.ComponentManagerImpl

All Implemented Interfaces:

ClockProvider, ComponentManager, OpenemsComponent, JsonApi, org.osgi.service.cm.ConfigurationListener

public class ComponentManagerImpl
extends AbstractOpenemsComponent
implements ComponentManager, OpenemsComponent, JsonApi, org.osgi.service.cm.ConfigurationListener

Nested Class Summary

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

ComponentManager.ChannelId

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

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected org.osgi.framework.BundleContext	bundleContext
protected org.osgi.service.cm.ConfigurationAdmin	cm
protected org.osgi.service.event.EventAdmin	eventAdmin
protected org.osgi.service.metatype.MetaTypeService	metaTypeService
protected org.osgi.service.component.runtime.ServiceComponentRuntime	serviceComponentRuntime

Fields inherited from interface io.openems.edge.common.component.ComponentManager

SINGLETON_COMPONENT_ID, SINGLETON_SERVICE_PID

Constructor Summary

Constructors

Constructor	Description
ComponentManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	configurationEvent(org.osgi.service.cm.ConfigurationEvent event)
protected void	deactivate()	Handles @Deactivate of implementations.
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
List<OpenemsComponent>	getAllComponents()	Gets all OpenEMS-Components.
Clock	getClock()	Gets the OpenEMS Clock - either the real system clock or a mocked clock for simulations.
<T extends OpenemsComponent> T	getComponent(String componentId)	Gets a OpenEMS-Component by its Component-ID.
EdgeConfig	getEdgeConfig()	Gets the complete configuration of this OpenEMS Edge.
List<OpenemsComponent>	getEnabledComponents()	Gets all enabled OpenEMS-Components.
<T extends OpenemsComponent> List<T>	getEnabledComponentsOfType(Class<T> clazz)	Gets all enabled OpenEMS-Components of the given Type.
protected org.osgi.service.cm.Configuration	getExistingConfigForId(String componentId)	Gets the ConfigAdmin Configuration for the OpenEMS Component with the given Component-ID.
<T extends OpenemsComponent> T	getPossiblyDisabledComponent(String componentId)	Gets a OpenEMS-Component by its Component-ID.
protected CompletableFuture<JsonrpcResponseSuccess>	handleChannelExportXlsxRequest(User user, ChannelExportXlsxRequest request)	Handles a ChannelExportXlsxRequest.
CompletableFuture<JsonrpcResponseSuccess>	handleCreateComponentConfigRequest(User user, CreateComponentConfigRequest request)	Handles a CreateComponentConfigRequest.
CompletableFuture<JsonrpcResponseSuccess>	handleDeleteComponentConfigRequest(User user, DeleteComponentConfigRequest request)	Handles a DeleteComponentConfigRequest.
CompletableFuture<JsonrpcResponseSuccess>	handleJsonrpcRequest(User user, JsonrpcRequest request)	Handles a JSON-RPC Request.
CompletableFuture<JsonrpcResponseSuccess>	handleUpdateComponentConfigRequest(User user, UpdateComponentConfigRequest request)	Handles a UpdateComponentConfigRequest.
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.

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

_setConfigNotActivated, _setDefaultConfigurationFailed, _setDuplicatedComponentId, _setWasOutOfMemory, getChannel, getConfigNotActivated, getConfigNotActivatedChannel, getDefaultConfigurationFailed, getDefaultConfigurationFailedChannel, getDuplicatedComponentId, getDuplicatedComponentIdChannel, getWasOutOfMemory, getWasOutOfMemoryChannel

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

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

Field Details

bundleContext

protected org.osgi.framework.BundleContext bundleContext

metaTypeService

protected org.osgi.service.metatype.MetaTypeService metaTypeService

cm

protected org.osgi.service.cm.ConfigurationAdmin cm

eventAdmin

protected org.osgi.service.event.EventAdmin eventAdmin

serviceComponentRuntime

protected org.osgi.service.component.runtime.ServiceComponentRuntime serviceComponentRuntime

Constructor Details

ComponentManagerImpl

public ComponentManagerImpl()

Method Details

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

getEnabledComponents

public List<OpenemsComponent> getEnabledComponents()

Description copied from interface: ComponentManager

Gets all enabled OpenEMS-Components.

Be aware that via this method usage of the Component service is not tracked by the bundle's use count (See BundleContext.getService(org.osgi.framework.ServiceReference)). Make sure to use the references as shortly as possible.

Specified by:

getEnabledComponents in interface ComponentManager

Returns:

a List of OpenEMS-Components

getEnabledComponentsOfType

public <T extends OpenemsComponent> List<T> getEnabledComponentsOfType(Class<T> clazz)

Description copied from interface: ComponentManager

Gets all enabled OpenEMS-Components of the given Type.

Be aware that via this method usage of the Component service is not tracked by the bundle's use count (See BundleContext.getService(org.osgi.framework.ServiceReference)). Make sure to use the references as shortly as possible.

Specified by:

getEnabledComponentsOfType in interface ComponentManager

Type Parameters:

T - the given Type, subclass of OpenemsComponent

Parameters:

clazz - the given Type, subclass of OpenemsComponent

Returns:

a List of OpenEMS-Components

getAllComponents

public List<OpenemsComponent> getAllComponents()

Description copied from interface: ComponentManager

Gets all OpenEMS-Components.

Be aware that via this method usage of the Component service is not tracked by the bundle's use count (See BundleContext.getService(org.osgi.framework.ServiceReference)). Make sure to use the references as shortly as possible.

Specified by:

getAllComponents in interface ComponentManager

Returns:

a List of OpenEMS-Components

getComponent

public <T extends OpenemsComponent> T getComponent(String componentId)
                                            throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentManager

Gets a OpenEMS-Component by its Component-ID. The Component is guaranteed to be enabled.

Be aware that via this method usage of the Component service is not tracked by the bundle's use count (See BundleContext.getService(org.osgi.framework.ServiceReference)). Make sure to use the references as shortly as possible.

Specified by:

getComponent in interface ComponentManager

Type Parameters:

T - the typed Component

Parameters:

componentId - the Component-ID (e.g. "_sum")

Returns:

the OpenEMS-Component

Throws:

OpenemsError.OpenemsNamedException - if the Component was not found

getPossiblyDisabledComponent

public <T extends OpenemsComponent> T getPossiblyDisabledComponent(String componentId)
                                                            throws OpenemsError.OpenemsNamedException

Description copied from interface: ComponentManager

Gets a OpenEMS-Component by its Component-ID. Be careful, that the Component might not be 'enabled'. If in doubt, use ComponentManager.getComponent(String) instead.

Be aware that via this method usage of the Component service is not tracked by the bundle's use count (See BundleContext.getService(org.osgi.framework.ServiceReference)). Make sure to use the references as shortly as possible.

Specified by:

getPossiblyDisabledComponent in interface ComponentManager

Type Parameters:

T - the typed Component

Parameters:

componentId - the Component-ID (e.g. "_sum")

Returns:

the OpenEMS-Component

Throws:

OpenemsError.OpenemsNamedException - if the Component was not found

debugLog

public String debugLog()

Description copied from interface: OpenemsComponent

Gets some output that is suitable for a continuous Debug log. Returns 'null' by default which causes no output.

Specified by:

debugLog in interface OpenemsComponent

Returns:

the debug log output

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

handleJsonrpcRequest

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

handleCreateComponentConfigRequest

public CompletableFuture<JsonrpcResponseSuccess> handleCreateComponentConfigRequest(User user,
 CreateComponentConfigRequest request)
                                                                             throws OpenemsError.OpenemsNamedException

Handles a CreateComponentConfigRequest.

Parameters:

user - the User

request - the CreateComponentConfigRequest

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

handleUpdateComponentConfigRequest

public CompletableFuture<JsonrpcResponseSuccess> handleUpdateComponentConfigRequest(User user,
 UpdateComponentConfigRequest request)
                                                                             throws OpenemsError.OpenemsNamedException

Handles a UpdateComponentConfigRequest.

Parameters:

user - the User

request - the UpdateComponentConfigRequest

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

handleDeleteComponentConfigRequest

public CompletableFuture<JsonrpcResponseSuccess> handleDeleteComponentConfigRequest(User user,
 DeleteComponentConfigRequest request)
                                                                             throws OpenemsError.OpenemsNamedException

Handles a DeleteComponentConfigRequest.

Parameters:

user - the User

request - the DeleteComponentConfigRequest

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

handleChannelExportXlsxRequest

protected CompletableFuture<JsonrpcResponseSuccess> handleChannelExportXlsxRequest(User user,
 ChannelExportXlsxRequest request)
                                                                            throws OpenemsError.OpenemsNamedException

Handles a ChannelExportXlsxRequest.

Parameters:

user - the User

request - the ChannelExportXlsxRequest

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

getExistingConfigForId

protected org.osgi.service.cm.Configuration getExistingConfigForId(String componentId)
                                                            throws OpenemsError.OpenemsNamedException

Gets the ConfigAdmin Configuration for the OpenEMS Component with the given Component-ID.

Parameters:

componentId - the Component-ID

Returns:

the Configuration

Throws:

OpenemsError.OpenemsNamedException - on error

getEdgeConfig

public EdgeConfig getEdgeConfig()

Description copied from interface: ComponentManager

Gets the complete configuration of this OpenEMS Edge.

Internally updates the cache if necessary and publishes a CONFIG_UPDATE event on update.

Specified by:

getEdgeConfig in interface ComponentManager

Returns:

the EdgeConfig object

configurationEvent

public void configurationEvent(org.osgi.service.cm.ConfigurationEvent event)

Specified by:

configurationEvent in interface org.osgi.service.cm.ConfigurationListener

getClock

public Clock getClock()

Description copied from interface: ComponentManager

Gets the OpenEMS Clock - either the real system clock or a mocked clock for simulations.

Specified by:

getClock in interface ClockProvider

Specified by:

getClock in interface ComponentManager

Returns:

the Clock