Package io.openems.edge.core.appmanager
Interface AppManagerUtil
- All Known Implementing Classes:
AppManagerUtilImpl
public interface AppManagerUtil
-
Method Summary
Modifier and TypeMethodDescriptiongetAppById
(String appId) Gets theOpenemsApp
for the given appId.default AppConfiguration
getAppConfiguration
(ConfigurationTarget target, OpenemsAppInstance instance, Language language) Gets theAppConfiguration
with the given parameter.default AppConfiguration
getAppConfiguration
(ConfigurationTarget target, OpenemsApp app, OpenemsAppInstance instance, Language language) Gets theAppConfiguration
with the given parameter.getAppConfiguration
(ConfigurationTarget target, OpenemsApp app, String alias, com.google.gson.JsonObject properties, Language language) Gets theAppConfiguration
with the given parameter.default AppConfiguration
getAppConfiguration
(ConfigurationTarget target, String appId, String alias, com.google.gson.JsonObject properties, Language language) Gets theAppConfiguration
with the given parameter.getAppsWithDependencyTo
(OpenemsAppInstance instance) getInstanceById
(UUID instanceId) Gets theOpenemsAppInstance
for the given instanceId.
-
Method Details
-
getAppById
Gets theOpenemsApp
for the given appId.- Parameters:
appId
- the appId of theOpenemsApp
- Returns:
- the
OpenemsApp
- Throws:
NoSuchElementException
- if there is noOpenemsApp
with the given appId
-
getInstanceById
Gets theOpenemsAppInstance
for the given instanceId.- Parameters:
instanceId
- the instanceId of theOpenemsAppInstance
- Returns:
- the
OpenemsAppInstance
- Throws:
NoSuchElementException
- if there is notOpenemsAppInstance
with the given instanceId
-
getAppConfiguration
AppConfiguration getAppConfiguration(ConfigurationTarget target, OpenemsApp app, String alias, com.google.gson.JsonObject properties, Language language) throws OpenemsError.OpenemsNamedException Gets theAppConfiguration
with the given parameter.- Parameters:
target
- theConfigurationTarget
of the configurationapp
- theOpenemsApp
alias
- the alias of the instanceproperties
- theJsonObject
properties of the instancelanguage
- theLanguage
of the configuration- Returns:
- the
AppConfiguration
- Throws:
OpenemsException
- on errorOpenemsError.OpenemsNamedException
-
getAppConfiguration
default AppConfiguration getAppConfiguration(ConfigurationTarget target, String appId, String alias, com.google.gson.JsonObject properties, Language language) throws OpenemsError.OpenemsNamedException Gets theAppConfiguration
with the given parameter.- Parameters:
target
- theConfigurationTarget
of the configurationappId
- theOpenemsApp.getAppId()
of theOpenemsApp
alias
- the alias of the instanceproperties
- theJsonObject
properties of the instancelanguage
- theLanguage
of the configuration- Returns:
- the
AppConfiguration
- Throws:
OpenemsException
- on errorOpenemsError.OpenemsNamedException
-
getAppConfiguration
default AppConfiguration getAppConfiguration(ConfigurationTarget target, OpenemsApp app, OpenemsAppInstance instance, Language language) throws OpenemsError.OpenemsNamedException Gets theAppConfiguration
with the given parameter.- Parameters:
target
- theConfigurationTarget
of the configurationapp
- theOpenemsApp.getAppId()
of theOpenemsApp
instance
- theOpenemsAppInstance
language
- theLanguage
of the configuration- Returns:
- the
AppConfiguration
- Throws:
OpenemsException
- on errorOpenemsError.OpenemsNamedException
-
getAppConfiguration
default AppConfiguration getAppConfiguration(ConfigurationTarget target, OpenemsAppInstance instance, Language language) throws OpenemsError.OpenemsNamedException Gets theAppConfiguration
with the given parameter.- Parameters:
target
- theConfigurationTarget
of the configurationinstance
- theOpenemsAppInstance
language
- theLanguage
of the configuration- Returns:
- the
AppConfiguration
- Throws:
OpenemsException
- on errorOpenemsError.OpenemsNamedException
-
getAppsWithDependencyTo
- Parameters:
instance
- the instance which is referenced- Returns:
- the referencing instances
-