Package io.openems.common.session

Class AbstractUser

java.lang.Object

io.openems.common.session.AbstractUser

Direct Known Subclasses:

User, User

public abstract class AbstractUser
extends Object

Represents a User; shared by OpenEMS Backend ('io.openems.backend.common.metadata.User') and Edge ('io.openems.edge.common.user.User').

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractUser(String id, String name, Language language, Role globalRole, NavigableMap<String,Role> roles, com.google.gson.JsonObject settings)

Method Summary

Modifier and Type	Method	Description
NavigableMap<String,Role>	getEdgeRoles()	Gets all Roles for Edge-IDs.
Role	getGlobalRole()	Gets the global Role.
String	getId()
Language	getLanguage()	Gets the user language.
String	getName()
Optional<Role>	getRole(String edgeId)	Gets the Role for a given Edge-ID.
com.google.gson.JsonObject	getSettings()	Gets the settings for this user.
abstract boolean	hasMultipleEdges()	Gets the Number of Devices, that the user is allowed to see.
void	setLanguage(Language language)	Sets the user language.
void	setRole(String edgeId, Role role)	Sets the Role for a given Edge-ID.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractUser

protected AbstractUser(String id,
 String name,
 Language language,
 Role globalRole,
 NavigableMap<String,Role> roles,
 com.google.gson.JsonObject settings)

Method Details

getId

public String getId()

getName

public String getName()

getLanguage

public Language getLanguage()

Gets the user language.

Returns:

the language

setLanguage

public void setLanguage(Language language)

Sets the user language.

Parameters:

language - the Language

getEdgeRoles

public NavigableMap<String,Role> getEdgeRoles()

Gets all Roles for Edge-IDs.

Returns:

the map of Roles

getGlobalRole

public Role getGlobalRole()

Gets the global Role.

Returns:

Role

getRole

public Optional<Role> getRole(String edgeId)

Gets the Role for a given Edge-ID.

Parameters:

edgeId - the Edge-ID

Returns:

the Role

setRole

public void setRole(String edgeId,
 Role role)

Sets the Role for a given Edge-ID.

Parameters:

edgeId - the Edge-ID

role - the Role

getSettings

public com.google.gson.JsonObject getSettings()

Gets the settings for this user.

Returns:

the Role

hasMultipleEdges

public abstract boolean hasMultipleEdges()

Gets the Number of Devices, that the user is allowed to see.

Returns:

the numberOfDevices