Package io.openems.edge.core.appmanager

Interface AppCenterBackendUtil

All Known Implementing Classes:

AppCenterBackendUtilImpl

public interface AppCenterBackendUtil

Method Summary

Modifier and Type	Method	Description
CompletableFuture<? extends JsonrpcResponseSuccess>	addDeinstallAppInstanceHistory(User user, String appId, UUID instanceId)	Adds a deinstall app history entry to the key which installed the instance.
void	addInstallAppInstanceHistory(User user, String key, String appId, UUID instanceId)	Adds a install app history entry to the given key.
List<AppCenterGetInstalledAppsResponse.Instance>	getInstalledApps()	Gets the installed apps that were logged in the backend.
List<AppCenterGetPossibleAppsResponse.Bundle>	getPossibleApps(String key)	Gets the possible apps that can be installed with the given key.
boolean	isConnected()	Gets if this edge is connected to the backend.
boolean	isKeyApplicable(User user, String key, String appId)	Gets from the backend if the given key can be applied to the given appId.

Method Details

isKeyApplicable

boolean isKeyApplicable(User user,
 String key,
 String appId)
                 throws OpenemsError.OpenemsNamedException

Gets from the backend if the given key can be applied to the given appId.

Parameters:

user - the executing user

key - the key to be validated

appId - the id of the OpenemsApp

Returns:

true if the key can be applied

Throws:

OpenemsError.OpenemsNamedException

addInstallAppInstanceHistory

void addInstallAppInstanceHistory(User user,
 String key,
 String appId,
 UUID instanceId)
                           throws OpenemsError.OpenemsNamedException

Adds a install app history entry to the given key.

Parameters:

user - the executing user

key - the key the app should get installed with

appId - the app id of the created instance

instanceId - the instanceId of the created instance

Throws:

OpenemsError.OpenemsNamedException - on error

addDeinstallAppInstanceHistory

CompletableFuture<? extends JsonrpcResponseSuccess> addDeinstallAppInstanceHistory(User user,
 String appId,
 UUID instanceId)
                                                                            throws OpenemsError.OpenemsNamedException

Adds a deinstall app history entry to the key which installed the instance.

Parameters:

user - the executing user

appId - the app id of the removed instance

instanceId - the instanceId of the removed instance

Returns:

the CompletableFuture of the request

Throws:

OpenemsError.OpenemsNamedException - on error

isConnected

boolean isConnected()

Gets if this edge is connected to the backend.

Returns:

true if this edge is connected to the backend

getPossibleApps

List<AppCenterGetPossibleAppsResponse.Bundle> getPossibleApps(String key)

Gets the possible apps that can be installed with the given key.

Parameters:

key - the key that the apps can be installed with

Returns:

a list of bundles with a list of their apps

getInstalledApps

List<AppCenterGetInstalledAppsResponse.Instance> getInstalledApps()
                                                           throws OpenemsError.OpenemsNamedException

Gets the installed apps that were logged in the backend.

Returns:

the instances that should be installed

Throws:

OpenemsError.OpenemsNamedException