Package io.openems.edge.core.appmanager

Interface AppManagerUtil

All Known Implementing Classes:

AppManagerUtilImpl

public interface AppManagerUtil

Method Summary

Modifier and Type	Method	Description
Optional<OpenemsApp>	findAppById(String id)	Finds the OpenemsApp with the given id.
default OpenemsApp	findAppByIdOrError(String id)	Finds the OpenemsApp with the given id.
Optional<OpenemsAppInstance>	findInstanceById(UUID id)	Finds the OpenemsAppInstance with the given UUID.
default OpenemsAppInstance	findInstanceByIdOrError(UUID id)	Finds the OpenemsAppInstance with the given UUID.
default AppConfiguration	getAppConfiguration(ConfigurationTarget target, OpenemsAppInstance instance, Language language)	Gets the AppConfiguration with the given parameter.
default AppConfiguration	getAppConfiguration(ConfigurationTarget target, OpenemsApp app, OpenemsAppInstance instance, Language language)	Gets the AppConfiguration with the given parameter.
AppConfiguration	getAppConfiguration(ConfigurationTarget target, OpenemsApp app, String alias, com.google.gson.JsonObject properties, Language language)	Gets the AppConfiguration with the given parameter.
default AppConfiguration	getAppConfiguration(ConfigurationTarget target, String appId, String alias, com.google.gson.JsonObject properties, Language language)	Gets the AppConfiguration with the given parameter.
List<OpenemsAppInstance>	getAppsWithDependencyTo(OpenemsAppInstance instance)	Gets all Instances which have a dependency to the given instance.
List<OpenemsAppInstance>	getInstantiatedApps()	Gets a List of the current installed OpenemsAppInstance.
default List<OpenemsAppInstance>	getInstantiatedAppsOfApp(String appId)	Gets a List of the current installed OpenemsAppInstance which match the given appId.

Method Details

getInstantiatedApps

List<OpenemsAppInstance> getInstantiatedApps()

Gets a List of the current installed OpenemsAppInstance.

Returns:

the list of installed apps

getInstantiatedAppsOfApp

default List<OpenemsAppInstance> getInstantiatedAppsOfApp(String appId)

Gets a List of the current installed OpenemsAppInstance which match the given appId.

Parameters:

appId - the appId which should match with OpenemsAppInstance.appId

Returns:

a List of OpenemsAppInstance

findAppById

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

default 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

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

default 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

getAppConfiguration

AppConfiguration getAppConfiguration(ConfigurationTarget target,
 OpenemsApp app,
 String alias,
 com.google.gson.JsonObject properties,
 Language language)
                              throws OpenemsError.OpenemsNamedException

Gets the AppConfiguration with the given parameter.

Parameters:

target - the ConfigurationTarget of the configuration

app - the OpenemsApp

alias - the alias of the instance

properties - the JsonObject properties of the instance

language - the Language of the configuration

Returns:

the AppConfiguration

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

getAppConfiguration

default AppConfiguration getAppConfiguration(ConfigurationTarget target,
 String appId,
 String alias,
 com.google.gson.JsonObject properties,
 Language language)
                                      throws OpenemsError.OpenemsNamedException

Gets the AppConfiguration with the given parameter.

Parameters:

target - the ConfigurationTarget of the configuration

appId - the OpenemsApp.getAppId() of the OpenemsApp

alias - the alias of the instance

properties - the JsonObject properties of the instance

language - the Language of the configuration

Returns:

the AppConfiguration

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

getAppConfiguration

default AppConfiguration getAppConfiguration(ConfigurationTarget target,
 OpenemsApp app,
 OpenemsAppInstance instance,
 Language language)
                                      throws OpenemsError.OpenemsNamedException

Gets the AppConfiguration with the given parameter.

Parameters:

target - the ConfigurationTarget of the configuration

app - the OpenemsApp.getAppId() of the OpenemsApp

instance - the OpenemsAppInstance

language - the Language of the configuration

Returns:

the AppConfiguration

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

getAppConfiguration

default AppConfiguration getAppConfiguration(ConfigurationTarget target,
 OpenemsAppInstance instance,
 Language language)
                                      throws OpenemsError.OpenemsNamedException

Gets the AppConfiguration with the given parameter.

Parameters:

target - the ConfigurationTarget of the configuration

instance - the OpenemsAppInstance

language - the Language of the configuration

Returns:

the AppConfiguration

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

getAppsWithDependencyTo

List<OpenemsAppInstance> getAppsWithDependencyTo(OpenemsAppInstance instance)

Gets all Instances which have a dependency to the given instance.

Parameters:

instance - the instance which is referenced

Returns:

the referencing instances