Package io.openems.edge.core.appmanager

Class AbstractOpenemsApp<PROPERTY extends Nameable>

java.lang.Object

io.openems.edge.core.appmanager.AbstractOpenemsApp<PROPERTY>

All Implemented Interfaces:

ComponentManagerSupplier, ComponentUtilSupplier, OpenemsApp

Direct Known Subclasses:

AbstractEnumOpenemsApp, AbstractOpenemsAppWithProps

public abstract class AbstractOpenemsApp<PROPERTY extends Nameable>
extends Object
implements OpenemsApp, ComponentUtilSupplier, ComponentManagerSupplier

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.osgi.service.cm.ConfigurationAdmin	cm
protected final org.osgi.service.component.ComponentContext	componentContext
protected final ComponentManager	componentManager
protected final ComponentUtil	componentUtil

Fields inherited from interface io.openems.edge.core.appmanager.OpenemsApp

FALLBACK_IMAGE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOpenemsApp(ComponentManager componentManager, org.osgi.service.component.ComponentContext componentContext, org.osgi.service.cm.ConfigurationAdmin cm, ComponentUtil componentUtil)

Method Summary

Modifier and Type	Method	Description
protected abstract ThrowingTriFunction<ConfigurationTarget,Map<PROPERTY,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appPropertyConfigurationFactory()	Provides a factory for AppConfigurations.
protected final void	assertCheckables(ConfigurationTarget t, Checkable... checkables)
protected static final String	base64OfImage(URL url)
static ResourceBundle	createResourceBundle(Language l)	Gets the ResourceBundle based on the given Language.
static com.google.gson.JsonObject	fillUpProperties(OpenemsApp app, com.google.gson.JsonObject original)	Creates a copy of the original configuration and fills up properties which are binded bidirectional.
protected AppAssistant	getAppAssistant(Language l)
AppAssistant	getAppAssistant(User user)	Gets the AppAssistant for this OpenemsApp.
AppConfiguration	getAppConfiguration(ConfigurationTarget target, com.google.gson.JsonObject config, Language language)	Gets the AppConfiguration needed for the OpenemsApp.
String	getAppId()	Gets the unique App-ID of the OpenemsApp.
OpenemsAppPermissions	getAppPermissions()	Gets the OpenemsAppPermissions of this OpenemsApp.
ComponentManager	getComponentManager()	Gets a ComponentManager.
ComponentUtil	getComponentUtil()	Gets a ComponentUtil.
protected static final EdgeConfig.Component	getComponentWithFactoryId(List<EdgeConfig.Component> components, String factoryId)
protected String	getId(ConfigurationTarget t, Map<PROPERTY,com.google.gson.JsonElement> map, PROPERTY p, String defaultId)	Gets the id of the map with the given default id
String	getImage()	Gets the image of the OpenemsApp in Base64 encoding.
String	getName(Language language)	Gets the name of the OpenemsApp.
protected static String	getNullableTranslation(Language language, String key)
OpenemsAppPropertyDefinition[]	getProperties()	Gets all OpenemsAppPropertyDefinition of the app.
protected final PROPERTY	getPropertyByName(String name)
String	getShortName(Language language)	Gets the short name of the OpenemsApp.
protected static String	getTranslation(Language language, String key)
static ResourceBundle	getTranslationBundle(Language language)	Gets the ResourceBundle based on the given Language.
protected ValidatorConfig.Builder	getValidateBuilder()
protected List<String>	getValidationErrors(com.google.gson.JsonObject jProperties, List<Dependency> dependecies)	Validate the App configuration.
final ValidatorConfig	getValidatorConfig()	Gets the ValidatorConfig of this OpenemsApp.
protected String	getValueOrDefault(Map<PROPERTY,com.google.gson.JsonElement> map, PROPERTY property, String defaultValue)	Gets the value of the property in the map or the defaulValue if the property was not found.
boolean	hasProperty(String property)	Checks if the given property is in the Property class included.
protected ThrowingBiFunction<ConfigurationTarget,Map<PROPERTY,com.google.gson.JsonElement>,Map<String,Map<String,?>>,OpenemsError.OpenemsNamedException>	installationValidation()	The returning function gets called during app add or update.
protected abstract PROPERTY[]	propertyValues()
void	validate(OpenemsAppInstance instance)	Validate the OpenemsApp.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.openems.edge.core.appmanager.OpenemsApp

flags, getAppDescriptor, getCardinality, getCategories

Field Details

componentManager

protected final ComponentManager componentManager

cm

protected final org.osgi.service.cm.ConfigurationAdmin cm

componentContext

protected final org.osgi.service.component.ComponentContext componentContext

componentUtil

protected final ComponentUtil componentUtil

Constructor Details

AbstractOpenemsApp

protected AbstractOpenemsApp(ComponentManager componentManager,
 org.osgi.service.component.ComponentContext componentContext,
 org.osgi.service.cm.ConfigurationAdmin cm,
 ComponentUtil componentUtil)

Method Details

appPropertyConfigurationFactory

protected abstract ThrowingTriFunction<ConfigurationTarget,Map<PROPERTY,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException> appPropertyConfigurationFactory()

Provides a factory for AppConfigurations.

Returns:

a ThrowingFunction that creates a AppConfiguration from a Map of configuration properties for a given ConfigurationTarget in the specified language.

assertCheckables

protected final void assertCheckables(ConfigurationTarget t,
 Checkable... checkables)
                               throws OpenemsError.OpenemsNamedException

Throws:

OpenemsError.OpenemsNamedException

getAppConfiguration

public AppConfiguration getAppConfiguration(ConfigurationTarget target,
 com.google.gson.JsonObject config,
 Language language)
                                     throws OpenemsError.OpenemsNamedException

Description copied from interface: OpenemsApp

Gets the AppConfiguration needed for the OpenemsApp.

Specified by:

getAppConfiguration in interface OpenemsApp

Parameters:

target - the ConfigurationTarget

config - the configured app 'properties'

language - the language of the configuration

Returns:

the app Configuration

Throws:

OpenemsError.OpenemsNamedException

getAppId

public String getAppId()

Description copied from interface: OpenemsApp

Gets the unique App-ID of the OpenemsApp.

Specified by:

getAppId in interface OpenemsApp

Returns:

a unique PID, usually the ComponentConstants.COMPONENT_NAME of the OSGi Component provider.

getId

protected String getId(ConfigurationTarget t,
 Map<PROPERTY,com.google.gson.JsonElement> map,
 PROPERTY p,
 String defaultId)

Gets the id of the map with the given default id

e. g. defaultId: "ess0" => the next available id with the base-name "ess" and the the next available number

Parameters:

t - the configuration target

map - the configuration map

p - the Property which stores the id

defaultId - the defaultId to be used

Returns:

the found id

getValidationErrors

protected List<String> getValidationErrors(com.google.gson.JsonObject jProperties,
 List<Dependency> dependecies)

Validate the App configuration.

Parameters:

jProperties - a JsonObject holding the App properties

dependecies - the dependencies of the current instance

Returns:

a list of validation errors. Empty list says 'no errors'

getValidatorConfig

public final ValidatorConfig getValidatorConfig()

Description copied from interface: OpenemsApp

Gets the ValidatorConfig of this OpenemsApp.

Specified by:

getValidatorConfig in interface OpenemsApp

Returns:

the ValidatorConfig

getValidateBuilder

protected ValidatorConfig.Builder getValidateBuilder()

getValueOrDefault

protected String getValueOrDefault(Map<PROPERTY,com.google.gson.JsonElement> map,
 PROPERTY property,
 String defaultValue)

Gets the value of the property in the map or the defaulValue if the property was not found.

Parameters:

map - the configuration map

property - the property to be searched for

defaultValue - the default value

Returns:

the String value

hasProperty

public boolean hasProperty(String property)

Checks if the given property is in the Property class included.

Parameters:

property - the enum property

Returns:

true if it is included else false

installationValidation

protected ThrowingBiFunction<ConfigurationTarget,Map<PROPERTY,com.google.gson.JsonElement>,Map<String,Map<String,?>>,OpenemsError.OpenemsNamedException> installationValidation()

The returning function gets called during app add or update. The returned Checkables are executed after setting the network configuration.

e. g. the function can return a Checkable for checking if a device is reachable via network.

Returns:

a factory function which returns Checkables

validate

public void validate(OpenemsAppInstance instance)
              throws OpenemsError.OpenemsNamedException

Description copied from interface: OpenemsApp

Validate the OpenemsApp.

Specified by:

validate in interface OpenemsApp

Parameters:

instance - the app instance

Throws:

OpenemsError.OpenemsNamedException

fillUpProperties

public static com.google.gson.JsonObject fillUpProperties(OpenemsApp app,
 com.google.gson.JsonObject original)

Creates a copy of the original configuration and fills up properties which are binded bidirectional.

e. g. a property in a component is the same as one configured in the app so it directly gets stored in the component configuration and not twice to avoid miss matching errors.

Parameters:

original - the original configuration

app - the app to get the properties from

Returns:

a copy of the original one with the filled up properties

getAppPermissions

public OpenemsAppPermissions getAppPermissions()

Description copied from interface: OpenemsApp

Gets the OpenemsAppPermissions of this OpenemsApp.

Specified by:

getAppPermissions in interface OpenemsApp

Returns:

the permissions

getName

public String getName(Language language)

Description copied from interface: OpenemsApp

Gets the name of the OpenemsApp.

Specified by:

getName in interface OpenemsApp

Parameters:

language - the language of the name

Returns:

a human readable name

getShortName

public String getShortName(Language language)

Description copied from interface: OpenemsApp

Gets the short name of the OpenemsApp.

Specified by:

getShortName in interface OpenemsApp

Parameters:

language - the language of the name

Returns:

a human readable short name; can be null

getImage

public String getImage()

Description copied from interface: OpenemsApp

Gets the image of the OpenemsApp in Base64 encoding.

Specified by:

getImage in interface OpenemsApp

Returns:

a image representing the OpenemsApp

getProperties

public OpenemsAppPropertyDefinition[] getProperties()

Description copied from interface: OpenemsApp

Gets all OpenemsAppPropertyDefinition of the app.

Specified by:

getProperties in interface OpenemsApp

Returns:

the OpenemsAppPropertyDefinitions

getAppAssistant

public AppAssistant getAppAssistant(User user)

Description copied from interface: OpenemsApp

Gets the AppAssistant for this OpenemsApp.

Specified by:

getAppAssistant in interface OpenemsApp

Parameters:

user - the User

Returns:

the AppAssistant

getAppAssistant

protected AppAssistant getAppAssistant(Language l)

propertyValues

protected abstract PROPERTY[] propertyValues()

getPropertyByName

protected final PROPERTY getPropertyByName(String name)

getTranslation

protected static String getTranslation(Language language,
 String key)

getNullableTranslation

protected static String getNullableTranslation(Language language,
 String key)

getTranslationBundle

public static ResourceBundle getTranslationBundle(Language language)

Gets the ResourceBundle based on the given Language.

Parameters:

language - the Language of the translations

Returns:

the ResourceBundle

createResourceBundle

public static ResourceBundle createResourceBundle(Language l)

Gets the ResourceBundle based on the given Language.

Used in OpenemsApps to create their Type.getParamter().

Parameters:

l - the Language of the translations

Returns:

the ResourceBundle

base64OfImage

protected static final String base64OfImage(URL url)

getComponentWithFactoryId

protected static final EdgeConfig.Component getComponentWithFactoryId(List<EdgeConfig.Component> components,
 String factoryId)

getComponentManager

public ComponentManager getComponentManager()

Description copied from interface: ComponentManagerSupplier

Gets a ComponentManager.

Specified by:

getComponentManager in interface ComponentManagerSupplier

Returns:

the ComponentManager

getComponentUtil

public ComponentUtil getComponentUtil()

Description copied from interface: ComponentUtilSupplier

Gets a ComponentUtil.

Specified by:

getComponentUtil in interface ComponentUtilSupplier

Returns:

the ComponentUtil