Package io.openems.edge.common.user

Class User

java.lang.Object

io.openems.common.session.AbstractUser

io.openems.edge.common.user.User

Direct Known Subclasses:

DummyUser, ManagedUser

public class User
extends AbstractUser

A User used by OpenEMS Edge.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_EDGE_ID	Default-Edge-ID for User.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	User(java.lang.String id, java.lang.String name, Language language, Role role)	Constructs an User.

Method Summary

Modifier and Type	Method	Description
void	assertRoleIsAtLeast(java.lang.String resource, Role role)	Throws an exception if the Role (Global and Per-Edge-Role are the same for OpenEMS Edge User) is equal or more privileged than the given Role.
static User	from(com.google.gson.JsonObject j)	Parses a JsonObject to a User.
Role	getRole()	Gets the Role (Global and Per-Edge-Role are the same for OpenEMS Edge User).
java.lang.String	toString()

Methods inherited from class io.openems.common.session.AbstractUser

getEdgeRoles, getGlobalRole, getId, getLanguage, getName, getRole, setLanguage, setRole

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EDGE_ID

public static final java.lang.String DEFAULT_EDGE_ID

Default-Edge-ID for User.

See Also:

Constant Field Values

Constructor Detail

User

protected User(java.lang.String id,
               java.lang.String name,
               Language language,
               Role role)

Constructs an User.

Parameters:

id - the User-ID

name - the name

language - the Language

role - the Role; used as global Role and assigned to DEFAULT_EDGE_ID.

Method Detail

getRole

public Role getRole()

Gets the Role (Global and Per-Edge-Role are the same for OpenEMS Edge User).

Returns:

the Role

assertRoleIsAtLeast

public void assertRoleIsAtLeast(java.lang.String resource,
                                Role role)
                         throws OpenemsError.OpenemsNamedException

Throws an exception if the Role (Global and Per-Edge-Role are the same for OpenEMS Edge User) is equal or more privileged than the given Role.

Parameters:

resource - a resource identifier; used for the exception

role - the compared Role

Throws:

OpenemsError.OpenemsNamedException - if the global Role privileges are less

from

public static User from(com.google.gson.JsonObject j)
                 throws OpenemsError.OpenemsNamedException

Parses a JsonObject to a User.

 {
   "id": string,
   "name: string,
   "language"?: string,
   "role": string
 }
 

Parameters:

j - the JsonObject

Returns:

a User

Throws:

OpenemsError.OpenemsNamedException - on error

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object