Package io.openems.edge.core.appmanager

Class AppManagerImpl

java.lang.Object

io.openems.edge.common.component.AbstractOpenemsComponent

io.openems.edge.core.appmanager.AppManagerImpl

All Implemented Interfaces:

OpenemsComponent, JsonApi, AppManager

public class AppManagerImpl
extends AbstractOpenemsComponent
implements AppManager, OpenemsComponent, JsonApi

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.edge.core.appmanager.AppManager

AppManager.ChannelId

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

OpenemsComponent.ChannelId

Field Summary

Fields

Modifier and Type	Field	Description
protected List<OpenemsApp>	availableApps
protected AppCenterBackendUtil	backendUtil
protected ComponentManager	componentManager
protected ComponentUtil	componentUtil
protected final List<OpenemsAppInstance>	instantiatedApps
protected final Lock	lockModifyingApps
protected Validator	validator
protected boolean	waitingForModified
protected final Condition	waitingForModifiedCondition

Fields inherited from interface io.openems.edge.core.appmanager.AppManager

SINGLETON_COMPONENT_ID, SINGLETON_SERVICE_PID

Constructor Summary

Constructors

Constructor	Description
AppManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	_setAppsNotSyncedWithBackend(boolean value)	Internal method to set the 'nextValue' on AppManager.ChannelId.APPS_NOT_SYNCED_WITH_BACKEND Channel.
protected void	activate(org.osgi.service.component.ComponentContext componentContext, io.openems.edge.core.appmanager.Config config)
Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>>	appConfigs()	Gets an Iterable that loops thru every existing app instance and its configuration.
Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>>	appConfigs(Predicate<? super OpenemsAppInstance> filter)	Gets an Iterable that loops thru every existing app instance and its configuration.
Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>>	appConfigs(List<OpenemsAppInstance> instances, Predicate<? super OpenemsAppInstance> filter)	Gets an Iterable that loops thru every instance and its configuration.
protected void	deactivate()	Handles @Deactivate of implementations.
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
static Predicate<? super OpenemsAppInstance>	excludingInstanceIds(UUID... excludingInstanceIds)	Gets a filter for excluding instances.
final Optional<OpenemsApp>	findAppById(String id)	Finds the OpenemsApp with the given id.
final OpenemsApp	findAppByIdOrError(String id)	Finds the OpenemsApp with the given id.
protected final Optional<OpenemsAppInstance>	findInstanceById(UUID id)	Finds the OpenemsAppInstance with the given UUID.
protected final OpenemsAppInstance	findInstanceByIdOrError(UUID id)	Finds the OpenemsAppInstance with the given UUID.
final List<OpenemsAppInstance>	getInstantiatedApps()	Gets an unmodifiable list of the current instantiated apps.
final List<AppConfiguration>	getOtherAppConfigurations(UUID... ignoreIds)	Gets all AppConfigurations from the existing OpenemsAppInstances.
CompletableFuture<AddAppInstance.Response>	handleAddAppInstanceRequest(User user, AddAppInstance.Request request)	Handles AddAppInstance.
CompletableFuture<AddAppInstance.Response>	handleAddAppInstanceRequest(User user, AddAppInstance.Request request, boolean ignoreBackend)	Handles AddAppInstance.
CompletableFuture<? extends JsonrpcResponseSuccess>	handleDeleteAppInstanceRequest(User user, DeleteAppInstance.Request request)	Handles a DeleteAppInstance.
CompletableFuture<? extends JsonrpcResponseSuccess>	handleJsonrpcRequest(User user, JsonrpcRequest request)	Handles a JSON-RPC Request.
CompletableFuture<UpdateAppInstance.Response>	handleUpdateAppInstanceRequest(User user, UpdateAppInstance.Request request)	Handles UpdateAppInstance.
protected void	modified(org.osgi.service.component.ComponentContext componentContext, io.openems.edge.core.appmanager.Config config)

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

_channel, activate, activate, addChannel, addChannels, addChannels, alias, channels, getComponentContext, id, isEnabled, logDebug, logError, logInfo, logWarn, 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.core.appmanager.AppManager

_setDefectiveApp, _setWrongAppConfiguration, getAppsNotSyncedWithBackend, getAppsNotSyncedWithBackendChannel, getDefectiveApp, getDefectiveAppChannel, getWrongAppConfiguration, getWrongAppConfigurationChannel

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

availableApps

protected volatile List<OpenemsApp> availableApps

componentManager

protected ComponentManager componentManager

componentUtil

protected ComponentUtil componentUtil

validator

protected Validator validator

backendUtil

protected AppCenterBackendUtil backendUtil

instantiatedApps

protected final List<OpenemsAppInstance> instantiatedApps

lockModifyingApps

protected final Lock lockModifyingApps

waitingForModifiedCondition

protected final Condition waitingForModifiedCondition

waitingForModified

protected volatile boolean waitingForModified

Constructor Details

AppManagerImpl

public AppManagerImpl()

Method Details

activate

protected void activate(org.osgi.service.component.ComponentContext componentContext,
 io.openems.edge.core.appmanager.Config config)

modified

protected void modified(org.osgi.service.component.ComponentContext componentContext,
 io.openems.edge.core.appmanager.Config config)
                 throws OpenemsError.OpenemsNamedException

Throws:

OpenemsError.OpenemsNamedException

deactivate

protected void deactivate()

Description copied from class: AbstractOpenemsComponent

Handles @Deactivate of implementations. Prints log output.

Overrides:

deactivate in class AbstractOpenemsComponent

_setAppsNotSyncedWithBackend

public void _setAppsNotSyncedWithBackend(boolean value)

Description copied from interface: AppManager

Internal method to set the 'nextValue' on AppManager.ChannelId.APPS_NOT_SYNCED_WITH_BACKEND Channel.

Specified by:

_setAppsNotSyncedWithBackend in interface AppManager

Parameters:

value - the next value

getInstantiatedApps

public final List<OpenemsAppInstance> getInstantiatedApps()

Gets an unmodifiable list of the current instantiated apps.

Returns:

the list of instantiated apps

excludingInstanceIds

public static Predicate<? super OpenemsAppInstance> excludingInstanceIds(UUID... excludingInstanceIds)

Gets a filter for excluding instances.

Parameters:

excludingInstanceIds - the instances that should be excluded

Returns:

the filter

appConfigs

public Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>> appConfigs()

Gets an Iterable that loops thru every existing app instance and its configuration.

Returns:

the Iterable

appConfigs

public Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>> appConfigs(Predicate<? super OpenemsAppInstance> filter)

Gets an Iterable that loops thru every existing app instance and its configuration.

Parameters:

filter - the filter that gets applied to the instances

Returns:

the Iterable

appConfigs

public Iterable<Map.Entry<OpenemsAppInstance,AppConfiguration>> appConfigs(List<OpenemsAppInstance> instances,
 Predicate<? super OpenemsAppInstance> filter)

Gets an Iterable that loops thru every instance and its configuration.

Parameters:

instances - the instances

filter - the filter that gets applied to the instances

Returns:

the Iterable

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

findAppById

public final Optional<OpenemsApp> findAppById(String id)

Finds the OpenemsApp with the given id.

Parameters:

id - the OpenemsApp.getAppId() of the app.

Returns:

a Optional of the app

findAppByIdOrError

public final OpenemsApp findAppByIdOrError(String id)
                                    throws OpenemsError.OpenemsNamedException

Finds the OpenemsApp with the given id.

Parameters:

id - the OpenemsApp.getAppId() of the app.

Returns:

the app

Throws:

OpenemsError.OpenemsNamedException - if the app was not found

findInstanceById

protected final Optional<OpenemsAppInstance> findInstanceById(UUID id)

Finds the OpenemsAppInstance with the given UUID.

Parameters:

id - the id of the instance

Returns:

a Optional of the instance

findInstanceByIdOrError

protected final OpenemsAppInstance findInstanceByIdOrError(UUID id)
                                                    throws OpenemsError.OpenemsNamedException

Finds the OpenemsAppInstance with the given UUID.

Parameters:

id - the UUID of the instance

Returns:

the instance

Throws:

OpenemsError.OpenemsNamedException - if not found

getOtherAppConfigurations

public final List<AppConfiguration> getOtherAppConfigurations(UUID... ignoreIds)

Gets all AppConfigurations from the existing OpenemsAppInstances.

Parameters:

ignoreIds - the id's of the instances that should be ignored

Returns:

the AppConfigurations

handleAddAppInstanceRequest

public CompletableFuture<AddAppInstance.Response> handleAddAppInstanceRequest(User user,
 AddAppInstance.Request request,
 boolean ignoreBackend)
                                                                       throws OpenemsError.OpenemsNamedException

Handles AddAppInstance.

Parameters:

user - the User

request - the AddAppInstance Request

ignoreBackend - should only be used internally

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

handleAddAppInstanceRequest

public CompletableFuture<AddAppInstance.Response> handleAddAppInstanceRequest(User user,
 AddAppInstance.Request request)
                                                                       throws OpenemsError.OpenemsNamedException

Handles AddAppInstance.

Parameters:

user - the User

request - the AddAppInstance Request

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error

handleDeleteAppInstanceRequest

public CompletableFuture<? extends JsonrpcResponseSuccess> handleDeleteAppInstanceRequest(User user,
 DeleteAppInstance.Request request)
                                                                                   throws OpenemsError.OpenemsNamedException

Handles a DeleteAppInstance.

Parameters:

user - the user

request - the DeleteAppInstance

Returns:

the request id

Throws:

OpenemsError.OpenemsNamedException - on error

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

handleUpdateAppInstanceRequest

public CompletableFuture<UpdateAppInstance.Response> handleUpdateAppInstanceRequest(User user,
 UpdateAppInstance.Request request)
                                                                             throws OpenemsError.OpenemsNamedException

Handles UpdateAppInstance.

Parameters:

user - the User

request - the UpdateAppInstance Request

Returns:

the Future JSON-RPC Response

Throws:

OpenemsError.OpenemsNamedException - on error