Package io.openems.edge.app.api

Class RestJsonApiReadWrite

java.lang.Object

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

io.openems.edge.app.api.RestJsonApiReadWrite

All Implemented Interfaces:

OpenemsApp

public class RestJsonApiReadWrite
extends AbstractOpenemsApp<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 class	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,java.util.EnumMap<RestJsonApiReadWrite.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException>	appConfigurationFactory()	Provides a factory for AppConfigurations.
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[]	getCategorys()	Gets the OpenemsAppCategory of the OpenemsApp.
protected java.lang.Class<RestJsonApiReadWrite.Property>	getPropertyClass()

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

assertCheckables, base64OfImage, getAppConfiguration, getAppId, getComponentWithFactoryId, getId, getId, getImage, getName, getTranslation, getTranslationBundle, getValidateBuilder, getValidatorConfig, getValueOrDefault, 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, getImage, getName, getValidatorConfig, validate

Constructor Detail

RestJsonApiReadWrite

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

Method Detail

getAppAssistant

public AppAssistant getAppAssistant(Language language)

Description copied from interface: OpenemsApp

Gets the AppAssistant for this OpenemsApp.

Specified by:

getAppAssistant in interface OpenemsApp

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

getCategorys

public OpenemsAppCategory[] getCategorys()

Description copied from interface: OpenemsApp

Gets the OpenemsAppCategory of the OpenemsApp.

Specified by:

getCategorys 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,java.util.EnumMap<RestJsonApiReadWrite.Property,com.google.gson.JsonElement>,Language,AppConfiguration,OpenemsError.OpenemsNamedException> appConfigurationFactory()

Description copied from class: AbstractOpenemsApp

Provides a factory for AppConfigurations.

Specified by:

appConfigurationFactory in class AbstractOpenemsApp<RestJsonApiReadWrite.Property>

Returns:

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

getPropertyClass

protected java.lang.Class<RestJsonApiReadWrite.Property> getPropertyClass()

Specified by:

getPropertyClass in class AbstractOpenemsApp<RestJsonApiReadWrite.Property>