com.sitewhere.spi.user

Enum SiteWhereAuthority

java.lang.Object

java.lang.Enum<SiteWhereAuthority>

com.sitewhere.spi.user.SiteWhereAuthority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SiteWhereAuthority>

public enum SiteWhereAuthority
extends java.lang.Enum<SiteWhereAuthority>

Enumerates authorities used to control access to SiteWhere data.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Access Group for system access setting
AdminConsole REST services access
AdminOwnTenant Administer own tenant
AdminSchedules Administer all schedules
AdminSelf Administer own user profile
AdminTenants Administer all users
AdminUsers Administer all users
REST REST services access
ScheduleCommands Add scheduled job for batch or indivisual command invocation
Schedules Group for all schedules
Server Group for server administration
Tenants Group for all tenant authorities
Users Group for all user authorities
ViewServerInfo View global server information

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription()
java.lang.String	getName()
java.lang.String	getParent()
java.lang.String	getRoleName()
boolean	isGroup()
void	setDescription(java.lang.String description)
void	setGroup(boolean group)
void	setName(java.lang.String name)
void	setParent(java.lang.String parent)
static SiteWhereAuthority	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SiteWhereAuthority[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Server

public static final SiteWhereAuthority Server

Group for server administration

ViewServerInfo

public static final SiteWhereAuthority ViewServerInfo

View global server information

Access

public static final SiteWhereAuthority Access

Group for system access setting

REST

public static final SiteWhereAuthority REST

REST services access

AdminConsole

public static final SiteWhereAuthority AdminConsole

REST services access

Users

public static final SiteWhereAuthority Users

Group for all user authorities

AdminUsers

public static final SiteWhereAuthority AdminUsers

Administer all users

AdminSelf

public static final SiteWhereAuthority AdminSelf

Administer own user profile

Tenants

public static final SiteWhereAuthority Tenants

Group for all tenant authorities

AdminTenants

public static final SiteWhereAuthority AdminTenants

Administer all users

AdminOwnTenant

public static final SiteWhereAuthority AdminOwnTenant

Administer own tenant

Schedules

public static final SiteWhereAuthority Schedules

Group for all schedules

AdminSchedules

public static final SiteWhereAuthority AdminSchedules

Administer all schedules

ScheduleCommands

public static final SiteWhereAuthority ScheduleCommands

Add scheduled job for batch or indivisual command invocation

Method Detail

values

public static SiteWhereAuthority[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SiteWhereAuthority c : SiteWhereAuthority.values())
    System.out.println(c);

Returns:

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

valueOf

public static SiteWhereAuthority valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRoleName

public java.lang.String getRoleName()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getParent

public java.lang.String getParent()

setParent

public void setParent(java.lang.String parent)

isGroup

public boolean isGroup()

setGroup

public void setGroup(boolean group)