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

Interface AppManagerAppHelper

All Known Implementing Classes:

AppManagerAppHelperImpl

public interface AppManagerAppHelper

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

Method Details

installApp

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

Installs an OpenemsApp with all its Dependencys.

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

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

Updates an existing OpenemsAppInstance.

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

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

Deletes an OpenemsAppInstance.

Parameters:

user - the executing user

instance - the instance to delete

Returns:

a list of the removed OpenemsAppInstances

Throws:

OpenemsError.OpenemsNamedException - on error

getTemporaryApps

TemporaryApps getTemporaryApps()

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

Returns:

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