Package io.openems.backend.common.metadata

Interface AppCenterMetadata.UiData

All Superinterfaces:

AppCenterMetadata

All Known Implementing Classes:

MetadataOdoo

Enclosing interface:

AppCenterMetadata

@ProviderType
public static interface AppCenterMetadata.UiData
extends AppCenterMetadata

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.backend.common.metadata.AppCenterMetadata

AppCenterMetadata.EdgeData, AppCenterMetadata.UiData

Method Summary

Modifier and Type	Method	Description
String	getSuppliableKey(User user, String edgeId, String appId)	Gets a key that can be supplied to the installation of the given app.
boolean	isAppFree(User user, String appId)	Gets if the given app is free.
void	sendAddRegisterKeyHistory(String edgeId, String appId, String key, User user)	Sends a request to register a key.
void	sendAddUnregisterKeyHistory(String edgeId, String appId, String key, User user)	Sends a request to unregister a key.
com.google.gson.JsonArray	sendGetRegisteredKeys(String edgeId, String appId)	Sends a request to get all registered keys to the given edge and app.

Methods inherited from interface io.openems.backend.common.metadata.AppCenterMetadata

sendGetPossibleApps, sendIsKeyApplicable

Method Details

sendAddRegisterKeyHistory

void sendAddRegisterKeyHistory(String edgeId,
 String appId,
 String key,
 User user)
                        throws OpenemsError.OpenemsNamedException

Sends a request to register a key.

Parameters:

edgeId - the edge the key gets registered to

appId - the appId that gets registered

key - the key to register to the app

user - the user who added the registration

Throws:

OpenemsError.OpenemsNamedException - on error

sendAddUnregisterKeyHistory

void sendAddUnregisterKeyHistory(String edgeId,
 String appId,
 String key,
 User user)
                          throws OpenemsError.OpenemsNamedException

Sends a request to unregister a key.

Parameters:

edgeId - the edge

appId - the id of the app

key - the key

user - the user who removed the registration

Throws:

OpenemsError.OpenemsNamedException - on error

sendGetRegisteredKeys

com.google.gson.JsonArray sendGetRegisteredKeys(String edgeId,
 String appId)
                                         throws OpenemsError.OpenemsNamedException

Sends a request to get all registered keys to the given edge and app.

Parameters:

edgeId - the edge the registered key can be applied on

appId - the app of the registed key

Returns:

the result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getSuppliableKey

String getSuppliableKey(User user,
 String edgeId,
 String appId)
                 throws OpenemsError.OpenemsNamedException

Gets a key that can be supplied to the installation of the given app.

Parameters:

user - the requested user

edgeId - the edge to install the app on

appId - the app to install

Returns:

the key or null if none can be supplied

Throws:

OpenemsError.OpenemsNamedException - on error

isAppFree

boolean isAppFree(User user,
 String appId)
           throws OpenemsError.OpenemsNamedException

Gets if the given app is free.

Parameters:

user - the requested user

appId - the id of the app

Returns:

true if the app is free

Throws:

OpenemsError.OpenemsNamedException - on error