Package io.openems.edge.core.appmanager

Class AppCenterBackendUtilImpl

java.lang.Object

io.openems.edge.core.appmanager.AppCenterBackendUtilImpl

All Implemented Interfaces:

AppCenterBackendUtil

public class AppCenterBackendUtilImpl
extends Object
implements AppCenterBackendUtil

Constructor Summary

Constructors

Constructor	Description
AppCenterBackendUtilImpl(ComponentManager componentManager)

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.

Methods inherited from class java.lang.Object

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

Constructor Details

AppCenterBackendUtilImpl

public AppCenterBackendUtilImpl(ComponentManager componentManager)

Method Details

isKeyApplicable

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

Description copied from interface: AppCenterBackendUtil

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

Specified by:

isKeyApplicable in interface AppCenterBackendUtil

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

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

Description copied from interface: AppCenterBackendUtil

Adds a install app history entry to the given key.

Specified by:

addInstallAppInstanceHistory in interface AppCenterBackendUtil

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

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

Description copied from interface: AppCenterBackendUtil

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

Specified by:

addDeinstallAppInstanceHistory in interface AppCenterBackendUtil

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

getPossibleApps

public List<AppCenterGetPossibleAppsResponse.Bundle> getPossibleApps(String key)

Description copied from interface: AppCenterBackendUtil

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

Specified by:

getPossibleApps in interface AppCenterBackendUtil

Parameters:

key - the key that the apps can be installed with

Returns:

a list of bundles with a list of their apps

getInstalledApps

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

Description copied from interface: AppCenterBackendUtil

Gets the installed apps that were logged in the backend.

Specified by:

getInstalledApps in interface AppCenterBackendUtil

Returns:

the instances that should be installed

Throws:

OpenemsError.OpenemsNamedException

isConnected

public boolean isConnected()

Description copied from interface: AppCenterBackendUtil

Gets if this edge is connected to the backend.

Specified by:

isConnected in interface AppCenterBackendUtil

Returns:

true if this edge is connected to the backend