Package io.openems.edge.core.appmanager

Interface AppManagerUtil

All Known Implementing Classes:

AppManagerUtilImpl

public interface AppManagerUtil

Method Summary

Modifier and Type	Method	Description
OpenemsApp	getAppById(String appId)	Gets the OpenemsApp for the given appId.
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.
OpenemsAppInstance	getInstanceById(UUID instanceId)	Gets the OpenemsAppInstance for the given instanceId.

Method Details

getAppById

OpenemsApp getAppById(String appId)
               throws NoSuchElementException

Gets the OpenemsApp for the given appId.

Parameters:

appId - the appId of the OpenemsApp

Returns:

the OpenemsApp

Throws:

NoSuchElementException - if there is no OpenemsApp with the given appId

getInstanceById

OpenemsAppInstance getInstanceById(UUID instanceId)
                            throws NoSuchElementException

Gets the OpenemsAppInstance for the given instanceId.

Parameters:

instanceId - the instanceId of the OpenemsAppInstance

Returns:

the OpenemsAppInstance

Throws:

NoSuchElementException - if there is not OpenemsAppInstance with the given instanceId

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