Package org.openremote.model.security

Enum Class ClientRole

java.lang.Object

java.lang.Enum<ClientRole>

org.openremote.model.security.ClientRole

All Implemented Interfaces:

Serializable, Comparable<ClientRole>, Constable

public enum ClientRole
extends Enum<ClientRole>

Roles available for our client application on Keycloak.

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
READ
READ_ADMIN
READ_ALARMS
READ_ASSETS
READ_INSIGHTS
READ_LOGS
READ_MAP
READ_RULES
READ_USERS
WRITE
WRITE_ADMIN
WRITE_ALARMS
WRITE_ASSETS
WRITE_ATTRIBUTES
WRITE_INSIGHTS
WRITE_LOGS
WRITE_RULES
WRITE_USER

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	ALL_ROLES
protected final ClientRole[]	composites
protected final String	description
protected final String	value

Method Summary

Modifier and Type	Method	Description
ClientRole[]	getComposites()
String	getDescription()
org.keycloak.representations.idm.RoleRepresentation	getRepresentation()
String	getValue()
static ClientRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static String[]	valueOf(ClientRole... roles)	Returns the enum constant of this class with the specified name.
static ClientRole[]	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

READ_ADMIN

public static final ClientRole READ_ADMIN

READ_LOGS

public static final ClientRole READ_LOGS

READ_USERS

public static final ClientRole READ_USERS

READ_MAP

public static final ClientRole READ_MAP

READ_ASSETS

public static final ClientRole READ_ASSETS

READ_RULES

public static final ClientRole READ_RULES

READ_INSIGHTS

public static final ClientRole READ_INSIGHTS

READ_ALARMS

public static final ClientRole READ_ALARMS

WRITE_USER

public static final ClientRole WRITE_USER

WRITE_ADMIN

public static final ClientRole WRITE_ADMIN

WRITE_LOGS

public static final ClientRole WRITE_LOGS

WRITE_ASSETS

public static final ClientRole WRITE_ASSETS

WRITE_ATTRIBUTES

public static final ClientRole WRITE_ATTRIBUTES

WRITE_RULES

public static final ClientRole WRITE_RULES

WRITE_INSIGHTS

public static final ClientRole WRITE_INSIGHTS

WRITE_ALARMS

public static final ClientRole WRITE_ALARMS

READ

public static final ClientRole READ

WRITE

public static final ClientRole WRITE

Field Details

ALL_ROLES

public static final Set<String> ALL_ROLES

value

protected final String value

description

protected final String description

composites

protected final ClientRole[] composites

Method Details

values

public static ClientRole[] 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 ClientRole 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

getValue

public String getValue()

getDescription

public String getDescription()

getComposites

public ClientRole[] getComposites()

getRepresentation

public org.keycloak.representations.idm.RoleRepresentation getRepresentation()

valueOf

public static String[] valueOf(ClientRole... roles)

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:

roles - 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