Package io.openems.backend.metadata.file

Class MetadataFile

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.common.metadata.AbstractMetadata

io.openems.backend.metadata.file.MetadataFile

All Implemented Interfaces:

Metadata, org.osgi.service.event.EventHandler

public class MetadataFile
extends AbstractMetadata
implements Metadata, org.osgi.service.event.EventHandler

This implementation of MetadataService reads Edges configuration from a file. The layout of the file is as follows:

 {
   edges: {
     [edgeId: string]: {
       comment: string,
       apikey: string
       setuppassword?: string
     }
   }
 }
 

This implementation does not require any login. It always serves the same user, which has 'ADMIN'-permissions on all given Edges.

Nested Class Summary

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

Metadata.Events, Metadata.GenericSystemLog

Constructor Summary

Constructors

Constructor	Description
MetadataFile()

Method Summary

Modifier and Type	Method	Description
void	addEdgeToUser(User user, Edge edge)	Assigns Edge to current user.
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.
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<User>	getUser(String userId)	Gets the User for the given User-ID.
List<AlertingSetting>	getUserAlertingSettings(String edgeId)	Gets all the alerting settings for given edge id.
AlertingSetting	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.
void	handleEvent(org.osgi.service.event.Event event)
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 jsonObject, OpenemsOEM.Manufacturer oem)	Register a user.
void	setUserAlertingSettings(User user, String edgeId, List<AlertingSetting> users)	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 locale)	Update language from given user.

Methods inherited from class io.openems.backend.common.metadata.AbstractMetadata

isInitialized, setInitialized

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logDebug, logError, logError, logInfo, logInfo, logWarn, logWarn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addEdgeToUser, getEdgeOrError, isInitialized

Constructor Details

MetadataFile

public MetadataFile()

Method Details

authenticate

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

Description copied from interface: Metadata

Authenticates the User by username and password.

Specified by:

authenticate in interface Metadata

Parameters:

username - the Username

password - the Password

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

public User authenticate(String token)
                  throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Authenticates the User by a Token.

Specified by:

authenticate in interface Metadata

Parameters:

token - the Token

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

logout

public void logout(User user)

Description copied from interface: Metadata

Closes a session for a User.

Specified by:

logout in interface Metadata

Parameters:

user - the User

getEdgeIdForApikey

public Optional<String> getEdgeIdForApikey(String apikey)

Description copied from interface: Metadata

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

Specified by:

getEdgeIdForApikey in interface Metadata

Parameters:

apikey - the API-Key

Returns:

the Edge-ID or Empty

getEdgeBySetupPassword

public Optional<Edge> getEdgeBySetupPassword(String setupPassword)

Description copied from interface: Metadata

Get an Edge by Edge-SetupPassword.

Specified by:

getEdgeBySetupPassword in interface Metadata

Parameters:

setupPassword - to find Edge

Returns:

Edge as a Optional

getEdge

public Optional<Edge> getEdge(String edgeId)

Description copied from interface: Metadata

Get an Edge by its unique Edge-ID.

Specified by:

getEdge in interface Metadata

Parameters:

edgeId - the Edge-ID

Returns:

the Edge as Optional

getUser

public Optional<User> getUser(String userId)

Description copied from interface: Metadata

Gets the User for the given User-ID.

Specified by:

getUser in interface Metadata

Parameters:

userId - the User-ID

Returns:

the User, or Empty

getAllOfflineEdges

public Collection<Edge> getAllOfflineEdges()

Description copied from interface: Metadata

Gets all Offline-Edges.

Specified by:

getAllOfflineEdges in interface Metadata

Returns:

collection of Edges.

addEdgeToUser

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

Description copied from interface: Metadata

Assigns Edge to current user.

If assignment fails, an OpenemsNamedException is thrown.

Specified by:

addEdgeToUser in interface Metadata

Parameters:

user - The User

edge - The Edge

Throws:

OpenemsError.OpenemsNamedException - on error

getUserInformation

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

Description copied from interface: Metadata

Gets information about the given user User.

Specified by:

getUserInformation in interface Metadata

Parameters:

user - User to read information

Returns:

Map about the user

Throws:

OpenemsError.OpenemsNamedException - on error

setUserInformation

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

Description copied from interface: Metadata

Update the given user User with new information JsonObject.

Specified by:

setUserInformation in interface Metadata

Parameters:

user - User to update

jsonObject - JsonObject information about the user

Throws:

OpenemsError.OpenemsNamedException - on error

getSetupProtocol

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

Description copied from interface: Metadata

Returns the Setup Protocol PDF for the given id.

Specified by:

getSetupProtocol in interface Metadata

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

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

Description copied from interface: Metadata

Return the Setup Protocol data as a JsonObject.

Specified by:

getSetupProtocolData in interface Metadata

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

public int submitSetupProtocol(User user,
 com.google.gson.JsonObject jsonObject)

Description copied from interface: Metadata

Submit the installation assistant protocol.

Specified by:

submitSetupProtocol in interface Metadata

Parameters:

user - User the current user

jsonObject - JsonObject the setup protocol

Returns:

id of created setup protocol

registerUser

public void registerUser(com.google.gson.JsonObject jsonObject,
 OpenemsOEM.Manufacturer oem)
                  throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Register a user.

Specified by:

registerUser in interface Metadata

Parameters:

jsonObject - JsonObject that represents an user

oem - OEM name

Throws:

OpenemsError.OpenemsNamedException - on error

updateUserLanguage

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

Description copied from interface: Metadata

Update language from given user.

Specified by:

updateUserLanguage in interface Metadata

Parameters:

user - User the current user

locale - to set language

Throws:

OpenemsError.OpenemsNamedException - on error

getEventAdmin

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

Description copied from interface: Metadata

Returns an EventAdmin, used by Edge objects.

Specified by:

getEventAdmin in interface Metadata

Returns:

EventAdmin

edge

public EdgeHandler edge()

Description copied from interface: Metadata

Handles operations with Edge.

To be completed. This should eventually replace Edge.

Specified by:

edge in interface Metadata

Returns:

an EdgeHandler

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

getSerialNumberForEdge

public Optional<String> getSerialNumberForEdge(Edge edge)

Description copied from interface: Metadata

Get serial number for the given Edge.

Specified by:

getSerialNumberForEdge in interface Metadata

Parameters:

edge - Edge to search for serial number

Returns:

Serial number or empty Optional

getUserAlertingSettings

public List<AlertingSetting> getUserAlertingSettings(String edgeId)

Description copied from interface: Metadata

Gets all the alerting settings for given edge id.

Specified by:

getUserAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

Returns:

List of AlertingSetting

getUserAlertingSettings

public AlertingSetting getUserAlertingSettings(String edgeId,
 String userId)
                                        throws OpenemsException

Description copied from interface: Metadata

Gets the alerting settings for given edge id and userId.

Specified by:

getUserAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

userId - the User ID

Returns:

List of UserRoleDelayTime

Throws:

OpenemsException - on error

setUserAlertingSettings

public void setUserAlertingSettings(User user,
 String edgeId,
 List<AlertingSetting> users)

Description copied from interface: Metadata

Sets the alerting settings for the given list of users.

Specified by:

setUserAlertingSettings in interface Metadata

Parameters:

user - User the current user

edgeId - the Edge-ID

users - list of users to update

getPageDevice

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

Description copied from interface: Metadata

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

Specified by:

getPageDevice in interface Metadata

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

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

Description copied from interface: Metadata

Gets the Role for a edge of the current user.

Specified by:

getEdgeMetadataForUser in interface Metadata

Parameters:

user - User the current user

edgeId - the Edge-ID

Returns:

the role to the edge

Throws:

OpenemsError.OpenemsNamedException - on error

logGenericSystemLog

public void logGenericSystemLog(Metadata.GenericSystemLog systemLog)

Description copied from interface: Metadata

Handles a Systemlog-Message.

Specified by:

logGenericSystemLog in interface Metadata

Parameters:

systemLog - the log