Package io.openems.backend.common.metadata

Interface Metadata

All Known Implementing Classes:

AbstractMetadata, DummyMetadata, MetadataDummy, MetadataFile, MetadataOdoo

@ProviderType
public interface Metadata

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	Metadata.Events	Defines Events a Metadata can throw.
static interface	Metadata.GenericSystemLog

Method Summary

Modifier and Type	Method	Description
static String	activeStateChannelsToString(Map<ChannelAddress,EdgeConfig.Component.Channel> activeStateChannels)	Helper method for creating a String of all active State-Channels by Level.
void	addEdgeToUser(User user, Edge edge)	Assigns Edge to current user.
default Edge	addEdgeToUser(User user, String setupPassword)	Assigns Edge with given setupPassword to the logged in user and returns it.
User	authenticate(String token)	Authenticates the User by a Token.
User	authenticate(String username, String password)	Authenticates the User by username and password.
EdgeHandler	edge()	Handles operations with Edge.
Collection<Edge>	getAllOfflineEdges()	Gets all Offline-Edges.
Optional<Edge>	getEdge(String edgeId)	Get an Edge by its unique Edge-ID.
Optional<Edge>	getEdgeBySetupPassword(String setupPassword)	Get an Edge by Edge-SetupPassword.
Optional<String>	getEdgeIdForApikey(String apikey)	Gets the Edge-ID for an API-Key, i.e.
GetEdgesResponse.EdgeMetadata	getEdgeMetadataForUser(User user, String edgeId)	Gets the Role for a edge of the current user.
List<OfflineEdgeAlertingSetting>	getEdgeOfflineAlertingSettings(String edgeId)	Gets all the offline-edge-alerting settings for given edge id.
default Edge	getEdgeOrError(String edgeId)	Get an Edge by its unique Edge-ID.
org.osgi.service.event.EventAdmin	getEventAdmin()	Returns an EventAdmin, used by Edge objects.
List<GetEdgesResponse.EdgeMetadata>	getPageDevice(User user, GetEdgesRequest.PaginationOptions paginationOptions)	Gets a map of Edge-IDs with the role of the given user.
Optional<String>	getSerialNumberForEdge(Edge edge)	Get serial number for the given Edge.
byte[]	getSetupProtocol(User user, int setupProtocolId)	Returns the Setup Protocol PDF for the given id.
com.google.gson.JsonObject	getSetupProtocolData(User user, String edgeId)	Return the Setup Protocol data as a JsonObject.
Optional<Level>	getSumState(String edgeId)	Get the SumState of the edge with the given edgeId.
List<SumStateAlertingSetting>	getSumStateAlertingSettings(String edgeId)	Gets all the sumState-alerting settings for given edge id.
Optional<User>	getUser(String userId)	Gets the User for the given User-ID.
List<UserAlertingSettings>	getUserAlertingSettings(String edgeId)	Gets all the alerting settings for given edge id.
UserAlertingSettings	getUserAlertingSettings(String edgeId, String userId)	Gets the alerting settings for given edge id and userId.
Map<String,Object>	getUserInformation(User user)	Gets information about the given user User.
boolean	isInitialized()	Was the Metadata service fully initialized?.
void	logGenericSystemLog(Metadata.GenericSystemLog systemLog)	Handles a Systemlog-Message.
void	logout(User user)	Closes a session for a User.
void	registerUser(com.google.gson.JsonObject user, String oem)	Register a user.
void	setUserAlertingSettings(User user, String edgeId, List<UserAlertingSettings> settings)	Sets the alerting settings for the given list of users.
void	setUserInformation(User user, com.google.gson.JsonObject jsonObject)	Update the given user User with new information JsonObject.
int	submitSetupProtocol(User user, com.google.gson.JsonObject jsonObject)	Submit the installation assistant protocol.
void	updateUserLanguage(User user, Language language)	Update language from given user.
void	updateUserSettings(User user, com.google.gson.JsonObject settings)	Updates the user settings.

Method Details

isInitialized

boolean isInitialized()

Was the Metadata service fully initialized?.

The service might take some time in the beginning to establish a connection or to cache data from an external database.

Returns:

true if it is initialized

authenticate

User authenticate(String username,
 String password)
           throws OpenemsError.OpenemsNamedException

Authenticates the User by username and password.

Parameters:

username - the Username

password - the Password

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

User authenticate(String token)
           throws OpenemsError.OpenemsNamedException

Authenticates the User by a Token.

Parameters:

token - the Token

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

logout

void logout(User user)

Closes a session for a User.

Parameters:

user - the User

edge

EdgeHandler edge()

Handles operations with Edge.

To be completed. This should eventually replace Edge.

Returns:

an EdgeHandler

getEdgeIdForApikey

Optional<String> getEdgeIdForApikey(String apikey)

Gets the Edge-ID for an API-Key, i.e. authenticates the API-Key.

Parameters:

apikey - the API-Key

Returns:

the Edge-ID or Empty

getEdge

Optional<Edge> getEdge(String edgeId)

Get an Edge by its unique Edge-ID.

Parameters:

edgeId - the Edge-ID

Returns:

the Edge as Optional

getEdgeOrError

default Edge getEdgeOrError(String edgeId)
                     throws OpenemsException

Get an Edge by its unique Edge-ID. Throws an Exception if there is no Edge with this ID.

Parameters:

edgeId - the Edge-ID

Returns:

the Edge

Throws:

OpenemsException - on error

getEdgeBySetupPassword

Optional<Edge> getEdgeBySetupPassword(String setupPassword)

Get an Edge by Edge-SetupPassword.

Parameters:

setupPassword - to find Edge

Returns:

Edge as a Optional

getUser

Optional<User> getUser(String userId)

Gets the User for the given User-ID.

Parameters:

userId - the User-ID

Returns:

the User, or Empty

getAllOfflineEdges

Collection<Edge> getAllOfflineEdges()

Gets all Offline-Edges.

Returns:

collection of Edges.

updateUserSettings

void updateUserSettings(User user,
 com.google.gson.JsonObject settings)
                 throws OpenemsError.OpenemsNamedException

Updates the user settings.

Parameters:

user - the user

settings - the user settings

Throws:

OpenemsError.OpenemsNamedException - on error

addEdgeToUser

default Edge addEdgeToUser(User user,
 String setupPassword)
                    throws OpenemsError.OpenemsNamedException

Assigns Edge with given setupPassword to the logged in user and returns it.

If the setupPassword is invalid, an OpenemsNamedException is thrown.

Parameters:

user - the User

setupPassword - the Setup-Password

Returns:

the Edge for the given Setup-Password

Throws:

OpenemsError.OpenemsNamedException - on error

addEdgeToUser

void addEdgeToUser(User user,
 Edge edge)
            throws OpenemsError.OpenemsNamedException

Assigns Edge to current user.

If assignment fails, an OpenemsNamedException is thrown.

Parameters:

user - The User

edge - The Edge

Throws:

OpenemsError.OpenemsNamedException - on error

activeStateChannelsToString

static String activeStateChannelsToString(Map<ChannelAddress,EdgeConfig.Component.Channel> activeStateChannels)

Helper method for creating a String of all active State-Channels by Level.

Parameters:

activeStateChannels - Map of ChannelAddress and EdgeConfig.Component.Channel; as returned by Edge.onSetSumState()

Returns:

a string

getUserInformation

Map<String,Object> getUserInformation(User user)
                               throws OpenemsError.OpenemsNamedException

Gets information about the given user User.

Parameters:

user - User to read information

Returns:

Map about the user

Throws:

OpenemsError.OpenemsNamedException - on error

setUserInformation

void setUserInformation(User user,
 com.google.gson.JsonObject jsonObject)
                 throws OpenemsError.OpenemsNamedException

Update the given user User with new information JsonObject.

Parameters:

user - User to update

jsonObject - JsonObject information about the user

Throws:

OpenemsError.OpenemsNamedException - on error

getSetupProtocol

byte[] getSetupProtocol(User user,
 int setupProtocolId)
                 throws OpenemsError.OpenemsNamedException

Returns the Setup Protocol PDF for the given id.

Parameters:

user - User the current user

setupProtocolId - the setup protocol id to search

Returns:

the Setup Protocol PDF as a byte array

Throws:

OpenemsError.OpenemsNamedException - on error

getSetupProtocolData

com.google.gson.JsonObject getSetupProtocolData(User user,
 String edgeId)
                                         throws OpenemsError.OpenemsNamedException

Return the Setup Protocol data as a JsonObject.

Parameters:

user - User the current user

edgeId - the Edge ID to get the data

Returns:

Setup Protocol as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

submitSetupProtocol

int submitSetupProtocol(User user,
 com.google.gson.JsonObject jsonObject)
                 throws OpenemsError.OpenemsNamedException

Submit the installation assistant protocol.

Parameters:

user - User the current user

jsonObject - JsonObject the setup protocol

Returns:

id of created setup protocol

Throws:

OpenemsError.OpenemsNamedException - on error

registerUser

void registerUser(com.google.gson.JsonObject user,
 String oem)
           throws OpenemsError.OpenemsNamedException

Register a user.

Parameters:

user - JsonObject that represents an user

oem - OEM name

Throws:

OpenemsError.OpenemsNamedException - on error

updateUserLanguage

void updateUserLanguage(User user,
 Language language)
                 throws OpenemsError.OpenemsNamedException

Update language from given user.

Parameters:

user - User the current user

language - to set language

Throws:

OpenemsError.OpenemsNamedException - on error

getUserAlertingSettings

UserAlertingSettings getUserAlertingSettings(String edgeId,
 String userId)
                                      throws OpenemsException

Gets the alerting settings for given edge id and userId.

Parameters:

edgeId - the Edge ID

userId - the User ID

Returns:

List of UserAlertingSettings

Throws:

OpenemsException - on error

getUserAlertingSettings

List<UserAlertingSettings> getUserAlertingSettings(String edgeId)
                                            throws OpenemsException

Gets all the alerting settings for given edge id.

Parameters:

edgeId - the Edge ID

Returns:

List of UserAlertingSettings

Throws:

OpenemsException - on error

getEdgeOfflineAlertingSettings

List<OfflineEdgeAlertingSetting> getEdgeOfflineAlertingSettings(String edgeId)
                                                         throws OpenemsException

Gets all the offline-edge-alerting settings for given edge id.

Parameters:

edgeId - the Edge ID

Returns:

List of OfflineEdgeAlertingSetting

Throws:

OpenemsException - on error

getSumStateAlertingSettings

List<SumStateAlertingSetting> getSumStateAlertingSettings(String edgeId)
                                                   throws OpenemsException

Gets all the sumState-alerting settings for given edge id.

Parameters:

edgeId - the Edge ID

Returns:

List of SumStateAlertingSetting

Throws:

OpenemsException - on error

setUserAlertingSettings

void setUserAlertingSettings(User user,
 String edgeId,
 List<UserAlertingSettings> settings)
                      throws OpenemsException

Sets the alerting settings for the given list of users.

Parameters:

user - User the current user

edgeId - the Edge-ID

settings - list of updated UserAlertingSettings

Throws:

OpenemsException - on error

getEventAdmin

org.osgi.service.event.EventAdmin getEventAdmin()

Returns an EventAdmin, used by Edge objects.

Returns:

EventAdmin

getSerialNumberForEdge

Optional<String> getSerialNumberForEdge(Edge edge)

Get serial number for the given Edge.

Parameters:

edge - Edge to search for serial number

Returns:

Serial number or empty Optional

getPageDevice

List<GetEdgesResponse.EdgeMetadata> getPageDevice(User user,
 GetEdgesRequest.PaginationOptions paginationOptions)
                                           throws OpenemsError.OpenemsNamedException

Gets a map of Edge-IDs with the role of the given user.

Parameters:

user - User the current user

paginationOptions - the options of the requesting page

Returns:

the role to the Edge-IDs

Throws:

OpenemsError.OpenemsNamedException - on error

getEdgeMetadataForUser

GetEdgesResponse.EdgeMetadata getEdgeMetadataForUser(User user,
 String edgeId)
                                              throws OpenemsError.OpenemsNamedException

Gets the Role for a edge of the current user.

Parameters:

user - User the current user

edgeId - the Edge-ID

Returns:

the role to the edge

Throws:

OpenemsError.OpenemsNamedException - on error

getSumState

Optional<Level> getSumState(String edgeId)

Get the SumState of the edge with the given edgeId.

Parameters:

edgeId - to search for

Returns:

sumState as Optional of Level

logGenericSystemLog

void logGenericSystemLog(Metadata.GenericSystemLog systemLog)

Handles a Systemlog-Message.

Parameters:

systemLog - the log