Package io.openems.common.session

Enum Class Role

java.lang.Object

java.lang.Enum<Role>

io.openems.common.session.Role

All Implemented Interfaces:

Serializable, Comparable<Role>, Constable

public enum Role
extends Enum<Role>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADMIN
GUEST
INSTALLER
OWNER

Method Summary

Modifier and Type	Method	Description
com.google.gson.JsonPrimitive	asJson()	Gets the Role as a JsonPrimitive.
Role	assertIsAtLeast(String resource, Role role)	Throws an exception if the current Role is equal or more privileged than the given Role.
int	getLevel()	The Level of this Role.
static Role	getRole(String name)	Returns the Role ENUM for this name or "GUEST" if it was not found.
boolean	isAtLeast(Role role)	Gets the information whether the current Role is equal or more privileged than the given Role.
boolean	isLessThan(Role role)	Gets the information whether the current Role is less privileged than the given Role.
static Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Role[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ADMIN

public static final Role ADMIN

INSTALLER

public static final Role INSTALLER

OWNER

public static final Role OWNER

GUEST

public static final Role GUEST

Method Details

values

public static Role[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Role valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getLevel

public int getLevel()

The Level of this Role. The lower the better.

Returns:

the level

getRole

public static Role getRole(String name)

Returns the Role ENUM for this name or "GUEST" if it was not found.

Parameters:

name - the name of the Role

Returns:

the Role

isAtLeast

public boolean isAtLeast(Role role)

Gets the information whether the current Role is equal or more privileged than the given Role.

Parameters:

role - the compared Role

Returns:

true if the current Role privileges are equal or higher

assertIsAtLeast

public Role assertIsAtLeast(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

isLessThan

public boolean isLessThan(Role role)

Gets the information whether the current Role is less privileged than the given Role.

Parameters:

role - the compared Role

Returns:

true if the current Role is less privileged

asJson

public com.google.gson.JsonPrimitive asJson()

Gets the Role as a JsonPrimitive.

Returns:

the JsonPrimitive