Package io.openems.edge.app.api

Class RestJsonApiReadOnly

java.lang.Object

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

io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps<RestJsonApiReadOnly,RestJsonApiReadOnly.Property,Type.Parameter.BundleParameter>

io.openems.edge.app.api.RestJsonApiReadOnly

All Implemented Interfaces:

OpenemsApp

public class RestJsonApiReadOnly
extends AbstractOpenemsAppWithProps<RestJsonApiReadOnly,RestJsonApiReadOnly.Property,Type.Parameter.BundleParameter>
implements OpenemsApp

Describes a App for ReadOnly Rest JSON Api.

  {
    "appId":"App.Api.RestJson.ReadOnly",
    "alias":"REST/JSON-Api Read-Only",
    "instanceId": UUID,
    "image": base64,
    "properties":{
        "ACTIVE": true,
        "CONTROLLER_ID": "ctrlApiRest0"
    },
    "appDescriptor": {
        "websiteUrl": AppDescriptor.getWebsiteUrl()
    }
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RestJsonApiReadOnly.Property

Nested classes/interfaces inherited from class io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps

AbstractOpenemsAppWithProps.Singleton<T>

Field Summary

Fields inherited from class io.openems.edge.core.appmanager.AbstractOpenemsApp

cm, componentContext, componentManager, componentUtil

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

FALLBACK_IMAGE

Constructor Summary

Constructors

Constructor	Description
RestJsonApiReadOnly(ComponentManager componentManager, org.osgi.service.component.ComponentContext context, org.osgi.service.cm.ConfigurationAdmin cm, ComponentUtil componentUtil)

Method Summary

Modifier and Type	Method	Description
protected ThrowingTriFunction<ConfigurationTarget,Map<RestJsonApiReadOnly.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appPropertyConfigurationFactory()	Provides a factory for AppConfigurations.
protected RestJsonApiReadOnly	getApp()
AppAssistant	getAppAssistant(Language language)	Gets the AppAssistant for this OpenemsApp.
AppDescriptor	getAppDescriptor()	Gets the AppDescriptor of the OpenemsApp.
OpenemsAppCardinality	getCardinality()	Gets the OpenemsAppCardinality of the OpenemsApp.
OpenemsAppCategory[]	getCategories()	Gets the OpenemsAppCategory of the OpenemsApp.
protected RestJsonApiReadOnly.Property[]	propertyValues()

Methods inherited from class io.openems.edge.core.appmanager.AbstractOpenemsAppWithProps

fillUpProperties, getAppConfiguration, getBoolean, getBoolean, getEnum, getEnum, getId, getInt, getInt, getJsonArray, getProperties, getString, getString, getValidationErrors, getValueOrDefault

Methods inherited from class io.openems.edge.core.appmanager.AbstractOpenemsApp

assertCheckables, base64OfImage, getAppId, getAppPermissions, getComponentWithFactoryId, getId, getImage, getName, getPropertyByName, getTranslation, getTranslationBundle, getValidateBuilder, getValidatorConfig, getValueOrDefault, hasProperty, installationValidation, validate

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

getAppConfiguration, getAppId, getAppPermissions, getImage, getName, getProperties, getValidatorConfig, validate

Constructor Details

RestJsonApiReadOnly

public RestJsonApiReadOnly(ComponentManager componentManager,
 org.osgi.service.component.ComponentContext context,
 org.osgi.service.cm.ConfigurationAdmin cm,
 ComponentUtil componentUtil)

Method Details

getAppAssistant

public AppAssistant getAppAssistant(Language language)

Description copied from interface: OpenemsApp

Gets the AppAssistant for this OpenemsApp.

Specified by:

getAppAssistant in interface OpenemsApp

Overrides:

getAppAssistant in class AbstractOpenemsAppWithProps<RestJsonApiReadOnly,RestJsonApiReadOnly.Property,Type.Parameter.BundleParameter>

Parameters:

language - the language of the AppAssistant

Returns:

the AppAssistant

getAppDescriptor

public AppDescriptor getAppDescriptor()

Description copied from interface: OpenemsApp

Gets the AppDescriptor of the OpenemsApp.

Specified by:

getAppDescriptor in interface OpenemsApp

Returns:

the AppDescriptor

getCategories

public OpenemsAppCategory[] getCategories()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCategory of the OpenemsApp.

Specified by:

getCategories in interface OpenemsApp

Returns:

the category's

getCardinality

public OpenemsAppCardinality getCardinality()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCardinality of the OpenemsApp.

Specified by:

getCardinality in interface OpenemsApp

Returns:

the usage

appPropertyConfigurationFactory

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

Description copied from class: AbstractOpenemsApp

Provides a factory for AppConfigurations.

Specified by:

appPropertyConfigurationFactory in class AbstractOpenemsApp<RestJsonApiReadOnly.Property>

Returns:

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

propertyValues

protected RestJsonApiReadOnly.Property[] propertyValues()

Specified by:

propertyValues in class AbstractOpenemsApp<RestJsonApiReadOnly.Property>

getApp

protected RestJsonApiReadOnly getApp()

Specified by:

getApp in class AbstractOpenemsAppWithProps<RestJsonApiReadOnly,RestJsonApiReadOnly.Property,Type.Parameter.BundleParameter>