io.openems.common.session

Class User

java.lang.Object

io.openems.common.session.User

Direct Known Subclasses:

EdgeUser

public class User
extends java.lang.Object

Represents a User.

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String id, java.lang.String name, Role role)

Method Summary

Modifier and Type	Method and Description
Role	assertRoleIsAtLeast(java.lang.String resource, Role role) Throws an exception if the current Role is equal or more privileged than the given Role.
static User	from(com.google.gson.JsonObject j)
java.lang.String	getId()
java.lang.String	getName()
Role	getRole()
com.google.gson.JsonObject	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

User

public User(java.lang.String id,
            java.lang.String name,
            Role role)

Method Detail

from

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

Throws:

OpenemsError.OpenemsNamedException

getId

public java.lang.String getId()

getName

public java.lang.String getName()

getRole

public Role getRole()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJson

public com.google.gson.JsonObject toJson()

assertRoleIsAtLeast

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

Throws an exception if the current Role is equal or more privileged than the given Role.

Parameters:

resource - a resource identifier; used for the exception

role - the compared Role

Returns:

the current Role

Throws:

OpenemsError.OpenemsNamedException - if the current Role privileges are less