Package io.openems.backend.metadata.odoo.odoo

Class OdooHandler

java.lang.Object

io.openems.backend.metadata.odoo.odoo.OdooHandler

public class OdooHandler
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final MetadataOdoo	parent

Constructor Summary

Constructors

Constructor	Description
OdooHandler(MetadataOdoo parent, EdgeCache edgeCache, Config config)

Method Summary

Modifier and Type	Method	Description
void	assignEdgeToUser(MyUser user, MyEdge edge, OdooUserRole userRole)	Assigns the given user with given OdooUserRole to the Edge.
String	authenticate(String username, String password)	Authenticates a user using Username and Password.
com.google.gson.JsonObject	authenticateSession(String sessionId)	Authenticates a user using a Session-ID.
com.google.gson.JsonObject	getAddDeinstallAppInstanceHistory(String edgeId, String appId, UUID instanceId, String userId)	Gets the response to add a deinstall app instance history entry.
com.google.gson.JsonObject	getAddInstallAppInstanceHistory(String key, String edgeId, String appId, UUID instanceId, String userId)	Gets the response to a add install app instance history entry.
com.google.gson.JsonObject	getAddRegisterKeyHistory(String edgeId, String appId, String key, MyUser user)	Gets the response to register a key.
com.google.gson.JsonObject	getAddUnregisterKeyHistory(String edgeId, String appId, String key, MyUser user)	Gets the response to unregister a key.
Optional<String>	getEdgeIdBySetupPassword(String setupPassword)	Returns Edge by setupPassword, otherwise an empty Optional.
com.google.gson.JsonObject	getEdges(MyUser user, GetEdgesRequest.PaginationOptions paginationOptions)	Gets the Edges of the given user matching the GetEdgesRequest.PaginationOptions.
com.google.gson.JsonObject	getEdgeWithRole(User user, String edgeId)	Gets the edge with the Role of the user.
com.google.gson.JsonObject	getInstalledApps(String edgeId)	Gets the installed apps.
com.google.gson.JsonObject	getIsKeyApplicable(String key, String edgeId, String appId)	Gets if the given key can be applied to the given app and edge id.
byte[]	getOdooSetupProtocolReport(int setupProtocolId)	Returns the Odoo report for a setup protocol.
List<OfflineEdgeAlertingSetting>	getOfflineAlertingSettings(String edgeName)	Get all offline-alerting specific settings for edge.
com.google.gson.JsonObject	getPossibleApps(String key, String edgeId)	Gets the possible apps to install with this key.
com.google.gson.JsonObject	getRegisteredKeys(String edgeId, String appId)	Gets the registered keys to a edge and app.
Optional<String>	getSerialNumberForEdge(Edge edge)	Get serial number for the given Edge.
com.google.gson.JsonObject	getSetupProtocolData(MyUser user, String edgeName)	Get latest Setup Protocol from Odoo or empty JsonObject if no protocol is available.
Level	getSumState(String edgeId)	Get the SumState of the edge with the given edgeId, via a ODOO-Request.
List<SumStateAlertingSetting>	getSumStateAlertingSettings(String edgeName)	Get all sum-state-alerting specific settings for edge.
List<UserAlertingSettings>	getUserAlertingSettings(String edgeId)	get all alerting settings for specified edge.
UserAlertingSettings	getUserAlertingSettings(String edgeId, String userId)	get alerting setting for user and edge.
Map<String,Object>	getUserInformation(MyUser user)	Returns information about the given MyUser.
void	logout(String sessionId)	Logout a User.
void	registerUser(com.google.gson.JsonObject jsonObject, OdooUserRole role, String oem)	Register an user in Odoo with the given OdooUserRole.
Future<OdooUtils.SuccessResponseAndHeaders>	sendNotificationMailAsync(ZonedDateTime sentAt, String template, com.google.gson.JsonElement params)	Call Odoo api to send multiple notification mails via Odoo async.
void	setUserAlertingSettings(MyUser user, String edgeId, List<UserAlertingSettings> userAlertingSettings)	Update or create the alerting setting for the given edge und list of users.
void	setUserInformation(MyUser user, com.google.gson.JsonObject userJson)	Update the given MyUser with information from JsonObject.
int	submitSetupProtocol(MyUser user, com.google.gson.JsonObject setupProtocolJson)	Save the Setup Protocol to Odoo.
void	updateUserLanguage(MyUser user, Language language)	Update language for the given user.
void	updateUserSettings(User user, com.google.gson.JsonObject settings)	Updates the settings of a user.
void	writeEdge(MyEdge edge, FieldValue<?>... fieldValues)	Writes one field to Odoo Edge model.
void	writeEdgeUser(EdgeUser edgeUser, FieldValue<?>... fieldValues)	Writes one field to Odoo EdgeUser model.

Methods inherited from class java.lang.Object

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

Field Details

parent

protected final MetadataOdoo parent

Constructor Details

OdooHandler

public OdooHandler(MetadataOdoo parent,
 EdgeCache edgeCache,
 Config config)

Method Details

writeEdge

public void writeEdge(MyEdge edge,
 FieldValue<?>... fieldValues)

Writes one field to Odoo Edge model.

Parameters:

edge - the Edge

fieldValues - the FieldValues

writeEdgeUser

public void writeEdgeUser(EdgeUser edgeUser,
 FieldValue<?>... fieldValues)

Writes one field to Odoo EdgeUser model.

Parameters:

edgeUser - the EdgeUser

fieldValues - the FieldValues

getEdgeIdBySetupPassword

public Optional<String> getEdgeIdBySetupPassword(String setupPassword)

Returns Edge by setupPassword, otherwise an empty Optional.

Parameters:

setupPassword - to find Edge

Returns:

Edge or empty Optional

assignEdgeToUser

public void assignEdgeToUser(MyUser user,
 MyEdge edge,
 OdooUserRole userRole)
                      throws OpenemsError.OpenemsNamedException

Assigns the given user with given OdooUserRole to the Edge. If Edge already assigned to user exit method.

Parameters:

user - the Odoo user

edge - the Odoo edge

userRole - the Odoo user role

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

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

Authenticates a user using Username and Password.

Parameters:

username - the Username

password - the Password

Returns:

the session_id

Throws:

OpenemsError.OpenemsNamedException - on login error

authenticateSession

public com.google.gson.JsonObject authenticateSession(String sessionId)
                                               throws OpenemsError.OpenemsNamedException

Authenticates a user using a Session-ID.

Parameters:

sessionId - the Odoo Session-ID

Returns:

the JsonObject received from /openems_backend/info.

Throws:

OpenemsError.OpenemsNamedException - on error

logout

public void logout(String sessionId)

Logout a User.

Parameters:

sessionId - the Session-ID

Throws:

OpenemsError.OpenemsNamedException - on error

getUserInformation

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

Returns information about the given MyUser.

Parameters:

user - the MyUser to get information

Returns:

the Field.Partner

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

setUserInformation

public void setUserInformation(MyUser user,
 com.google.gson.JsonObject userJson)
                        throws OpenemsError.OpenemsNamedException

Update the given MyUser with information from JsonObject.

Parameters:

user - the MyUser to update

userJson - the JsonObject information to update

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException

getOdooSetupProtocolReport

public byte[] getOdooSetupProtocolReport(int setupProtocolId)
                                  throws OpenemsError.OpenemsNamedException

Returns the Odoo report for a setup protocol.

Parameters:

setupProtocolId - the Odoo setup protocol id

Returns:

report as a byte array

Throws:

OpenemsError.OpenemsNamedException - on error

submitSetupProtocol

public int submitSetupProtocol(MyUser user,
 com.google.gson.JsonObject setupProtocolJson)
                        throws OpenemsError.OpenemsNamedException

Save the Setup Protocol to Odoo.

Parameters:

user - MyUser current user

setupProtocolJson - Field.SetupProtocol the setup protocol

Returns:

the Setup Protocol ID

Throws:

OpenemsError.OpenemsNamedException - on error

registerUser

public void registerUser(com.google.gson.JsonObject jsonObject,
 OdooUserRole role,
 String oem)
                  throws OpenemsError.OpenemsNamedException

Register an user in Odoo with the given OdooUserRole.

Parameters:

jsonObject - JsonObject that represents an user

role - OdooUserRole to set for the user

oem - OEM name

Throws:

OpenemsError.OpenemsNamedException - on error

sendNotificationMailAsync

public Future<OdooUtils.SuccessResponseAndHeaders> sendNotificationMailAsync(ZonedDateTime sentAt,
 String template,
 com.google.gson.JsonElement params)
                                                                      throws OpenemsError.OpenemsNamedException

Call Odoo api to send multiple notification mails via Odoo async.

Parameters:

sentAt - TimeStamp for last_notification field

template - template to use for mail

params - arguments for the template

Returns:

Future of OdooUtils.SuccessResponseAndHeaders

Throws:

OpenemsError.OpenemsNamedException - error

updateUserLanguage

public void updateUserLanguage(MyUser user,
 Language language)
                        throws OpenemsException

Update language for the given user.

Parameters:

user - MyUser the current user

language - to set

Throws:

OpenemsException - on error

getSetupProtocolData

public com.google.gson.JsonObject getSetupProtocolData(MyUser user,
 String edgeName)
                                                throws OpenemsError.OpenemsNamedException

Get latest Setup Protocol from Odoo or empty JsonObject if no protocol is available.

Parameters:

user - MyUser the current user

edgeName - the unique Edge name

Returns:

the Setup Protocol as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getSerialNumberForEdge

public Optional<String> getSerialNumberForEdge(Edge edge)

Get serial number for the given Edge.

Parameters:

edge - the Edge

Returns:

Serial number or empty Optional

getIsKeyApplicable

public com.google.gson.JsonObject getIsKeyApplicable(String key,
 String edgeId,
 String appId)
                                              throws OpenemsError.OpenemsNamedException

Gets if the given key can be applied to the given app and edge id.

Parameters:

key - the key to be validated

edgeId - the edgeId the app should get installed

appId - the appId of the app that should get installed

Returns:

the Response result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getAddInstallAppInstanceHistory

public com.google.gson.JsonObject getAddInstallAppInstanceHistory(String key,
 String edgeId,
 String appId,
 UUID instanceId,
 String userId)
                                                           throws OpenemsError.OpenemsNamedException

Gets the response to a add install app instance history entry.

Parameters:

key - the key to install the app with

edgeId - the id of the edge the app gets installed on

appId - the app that gets installed

instanceId - the instanceId of the create instance

userId - the user who added the instance

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getAddDeinstallAppInstanceHistory

public com.google.gson.JsonObject getAddDeinstallAppInstanceHistory(String edgeId,
 String appId,
 UUID instanceId,
 String userId)
                                                             throws OpenemsError.OpenemsNamedException

Gets the response to add a deinstall app instance history entry.

Parameters:

edgeId - the edge the app gets removed on

appId - the appId of the removed instance

instanceId - the instanceId of the removed instance

userId - the user who removed the instance

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getAddRegisterKeyHistory

public com.google.gson.JsonObject getAddRegisterKeyHistory(String edgeId,
 String appId,
 String key,
 MyUser user)
                                                    throws OpenemsError.OpenemsNamedException

Gets the response to register a key.

Parameters:

edgeId - the edgeId the key gets registered on.

appId - the appId the key gets registered to.

key - the key that gets registered

user - the user who registered the key

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getAddUnregisterKeyHistory

public com.google.gson.JsonObject getAddUnregisterKeyHistory(String edgeId,
 String appId,
 String key,
 MyUser user)
                                                      throws OpenemsError.OpenemsNamedException

Gets the response to unregister a key.

Parameters:

edgeId - the edgeId the registered key was assigned to.

appId - the appId the registered key was assigned to or null if assigned to edge.

key - the registered key

user - the user who deregistered the key

Returns:

the response result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getRegisteredKeys

public com.google.gson.JsonObject getRegisteredKeys(String edgeId,
 String appId)
                                             throws OpenemsError.OpenemsNamedException

Gets the registered keys to a edge and app.

Parameters:

edgeId - the edge the key is registered on

appId - the app the key is registered to

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getPossibleApps

public com.google.gson.JsonObject getPossibleApps(String key,
 String edgeId)
                                           throws OpenemsError.OpenemsNamedException

Gets the possible apps to install with this key.

Parameters:

key - the apps of which key

edgeId - the apps on which edge

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getInstalledApps

public com.google.gson.JsonObject getInstalledApps(String edgeId)
                                            throws OpenemsError.OpenemsNamedException

Gets the installed apps.

Parameters:

edgeId - the apps on which edge

Returns:

the result as JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

getUserAlertingSettings

public List<UserAlertingSettings> getUserAlertingSettings(String edgeId)
                                                   throws OpenemsException

get all alerting settings for specified edge.

Parameters:

edgeId - ID of Edge

Returns:

list of alerting settings

Throws:

OpenemsException - on error

getUserAlertingSettings

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

get alerting setting for user and edge.

Parameters:

edgeId - ID of Edge

userId - ID of User

Returns:

UserAlertingSettings or

invalid @link

{@link null

} if no settings are stored

Throws:

OpenemsException - on error

getOfflineAlertingSettings

public List<OfflineEdgeAlertingSetting> getOfflineAlertingSettings(String edgeName)
                                                            throws OpenemsException

Get all offline-alerting specific settings for edge.

Parameters:

edgeName - unique name of Edge

Returns:

List of OfflineEdgeAlertingSetting or

invalid @link

{@link null

} if no settings are stored

Throws:

OpenemsException - on error

getSumStateAlertingSettings

public List<SumStateAlertingSetting> getSumStateAlertingSettings(String edgeName)
                                                          throws OpenemsException

Get all sum-state-alerting specific settings for edge.

Parameters:

edgeName - unique name of Edge

Returns:

List of SumStateAlertingSetting or

invalid @link

{@link null

} if no settings are stored

Throws:

OpenemsException - on error

setUserAlertingSettings

public void setUserAlertingSettings(MyUser user,
 String edgeId,
 List<UserAlertingSettings> userAlertingSettings)
                             throws OpenemsException

Update or create the alerting setting for the given edge und list of users.

Parameters:

user - the current user

edgeId - the Edge

userAlertingSettings - list of users

Throws:

OpenemsException - on error

getEdges

public com.google.gson.JsonObject getEdges(MyUser user,
 GetEdgesRequest.PaginationOptions paginationOptions)
                                    throws OpenemsError.OpenemsNamedException

Gets the Edges of the given user matching the GetEdgesRequest.PaginationOptions.

Parameters:

user - the current MyUser

paginationOptions - the GetEdgesRequest.PaginationOptions

Returns:

the edges

Throws:

OpenemsError.OpenemsNamedException - on error

getEdgeWithRole

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

Gets the edge with the Role of the user.

Parameters:

user - the current MyUser

edgeId - the id of the edge

Returns:

the edge with the role of the user

Throws:

OpenemsError.OpenemsNamedException - on error

getSumState

public Level getSumState(String edgeId)
                  throws OpenemsException

Get the SumState of the edge with the given edgeId, via a ODOO-Request.

Parameters:

edgeId - to search for

Returns:

sumState as Level

Throws:

OpenemsException

updateUserSettings

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

Updates the settings of a user.

Parameters:

user - the user

settings - the settings of the user

Throws:

OpenemsError.OpenemsNamedException