Package io.openems.edge.app.api

Class RestJsonApiReadWrite

java.lang.Object

io.openems.edge.core.appmanager.AbstractOpenemsApp<RestJsonApiReadWrite.Property>

io.openems.edge.core.appmanager.AbstractEnumOpenemsApp<RestJsonApiReadWrite.Property>

io.openems.edge.app.api.RestJsonApiReadWrite

All Implemented Interfaces:

ComponentManagerSupplier, ComponentUtilSupplier, OpenemsApp

public class RestJsonApiReadWrite
extends AbstractEnumOpenemsApp<RestJsonApiReadWrite.Property>
implements OpenemsApp

Describes a App for ReadWrite Rest JSON Api.

  {
    "appId":"App.Api.RestJson.ReadWrite",
    "alias":"Rest/JSON-Api Read-Write",
    "instanceId": UUID,
    "image": base64,
    "properties":{
        "CONTROLLER_ID": "ctrlApiRest0",
        "API_TIMEOUT": 60
    },
    "dependencies": [
        {
                "key": "READ_ONLY",
                "instanceId": UUID
        }
    ],
    "appDescriptor": {
        "websiteUrl": AppDescriptor.getWebsiteUrl()
    }
  }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RestJsonApiReadWrite.Property

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
RestJsonApiReadWrite(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,EnumMap<RestJsonApiReadWrite.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appConfigurationFactory()
AppAssistant	getAppAssistant(Language language)
AppDescriptor	getAppDescriptor(OpenemsEdgeOem oem)	Gets the AppDescriptor of the OpenemsApp.
OpenemsAppCardinality	getCardinality()	Gets the OpenemsAppCardinality of the OpenemsApp.
OpenemsAppCategory[]	getCategories()	Gets the OpenemsAppCategory of the OpenemsApp.
protected Class<RestJsonApiReadWrite.Property>	getPropertyClass()

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

appPropertyConfigurationFactory, getId, getValueOrDefault, propertyValues

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

base64OfImage, createResourceBundle, fillUpProperties, getAppAssistant, getAppConfiguration, getAppId, getAppPermissions, getComponentManager, getComponentUtil, getComponentWithFactoryId, getId, getImage, getName, getNullableTranslation, getProperties, getPropertyByName, getShortName, getTranslation, getTranslationBundle, getValidateBuilder, getValidatorConfig, getValueOrDefault, hasProperty, installationValidation

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, getAppAssistant, getAppConfiguration, getAppId, getAppPermissions, getImage, getName, getProperties, getShortName, getValidatorConfig

Constructor Details

RestJsonApiReadWrite

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

Method Details

getAppAssistant

public AppAssistant getAppAssistant(Language language)

Overrides:

getAppAssistant in class AbstractOpenemsApp<RestJsonApiReadWrite.Property>

getAppDescriptor

public AppDescriptor getAppDescriptor(OpenemsEdgeOem oem)

Description copied from interface: OpenemsApp

Gets the AppDescriptor of the OpenemsApp.

Specified by:

getAppDescriptor in interface OpenemsApp

Parameters:

oem - the OpenemsEdgeOem

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

appConfigurationFactory

protected ThrowingTriFunction<ConfigurationTarget,EnumMap<RestJsonApiReadWrite.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException> appConfigurationFactory()

Specified by:

appConfigurationFactory in class AbstractEnumOpenemsApp<RestJsonApiReadWrite.Property>

getPropertyClass

protected Class<RestJsonApiReadWrite.Property> getPropertyClass()

Specified by:

getPropertyClass in class AbstractEnumOpenemsApp<RestJsonApiReadWrite.Property>