Package io.openems.edge.core.appmanager.dependency

Class AppManagerAppHelperImpl

java.lang.Object

io.openems.edge.core.appmanager.dependency.AppManagerAppHelperImpl

All Implemented Interfaces:

AppManagerAppHelper

public class AppManagerAppHelperImpl
extends Object
implements AppManagerAppHelper

Constructor Summary

Constructors

Constructor	Description
AppManagerAppHelperImpl(ComponentManager componentManager, ComponentUtil componentUtil)

Method Summary

Modifier and Type	Method	Description
UpdateValues	deleteApp(User user, OpenemsAppInstance instance)	Deletes an OpenemsAppInstance.
TemporaryApps	getTemporaryApps()	Only available during a call of one of the other methods.
static ResourceBundle	getTranslationBundle(Language language)	Gets the ResourceBundle based on the given Language.
static void	insert(List<AggregateTask<?>> tasks, AggregateTask<?> task)	Inserts a task into a existing list of tasks.
UpdateValues	installApp(User user, OpenemsAppInstance instance, OpenemsApp app)	Installs an OpenemsApp with all its Dependencys.
UpdateValues	updateApp(User user, OpenemsAppInstance oldInstance, OpenemsAppInstance instance, OpenemsApp app)	Updates an existing OpenemsAppInstance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AppManagerAppHelperImpl

public AppManagerAppHelperImpl(ComponentManager componentManager,
 ComponentUtil componentUtil)

Method Details

installApp

public UpdateValues installApp(User user,
 OpenemsAppInstance instance,
 OpenemsApp app)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: AppManagerAppHelper

Installs an OpenemsApp with all its Dependencys.

Specified by:

installApp in interface AppManagerAppHelper

Parameters:

user - the executing user

instance - the settings of the new OpenemsAppInstance

app - the OpenemsApp

Returns:

a list of the created OpenemsAppInstances

Throws:

OpenemsError.OpenemsNamedException - on error

updateApp

public UpdateValues updateApp(User user,
 OpenemsAppInstance oldInstance,
 OpenemsAppInstance instance,
 OpenemsApp app)
                       throws OpenemsError.OpenemsNamedException

Description copied from interface: AppManagerAppHelper

Updates an existing OpenemsAppInstance.

Specified by:

updateApp in interface AppManagerAppHelper

Parameters:

user - the executing user

oldInstance - the old OpenemsAppInstance with its configurations.

instance - the settings of the new OpenemsAppInstance

app - the OpenemsApp

Returns:

a list of the replaced OpenemsAppInstances

Throws:

OpenemsError.OpenemsNamedException - on error

deleteApp

public UpdateValues deleteApp(User user,
 OpenemsAppInstance instance)
                       throws OpenemsError.OpenemsNamedException

Description copied from interface: AppManagerAppHelper

Deletes an OpenemsAppInstance.

Specified by:

deleteApp in interface AppManagerAppHelper

Parameters:

user - the executing user

instance - the instance to delete

Returns:

a list of the removed OpenemsAppInstances

Throws:

OpenemsError.OpenemsNamedException - on error

getTranslationBundle

public static ResourceBundle getTranslationBundle(Language language)

Gets the ResourceBundle based on the given Language.

Parameters:

language - the Language of the translations

Returns:

the ResourceBundle

getTemporaryApps

public TemporaryApps getTemporaryApps()

Description copied from interface: AppManagerAppHelper

Only available during a call of one of the other methods.

Specified by:

getTemporaryApps in interface AppManagerAppHelper

Returns:

null if none of the other methods is currently running else the TemporaryApps

insert

public static void insert(List<AggregateTask<?>> tasks,
 AggregateTask<?> task)

Inserts a task into a existing list of tasks. The task gets inserted at a position which suits their AggregateTask.AggregateTaskExecuteConstraints.

Parameters:

tasks - the existing task list

task - the task to insert