org.cyclos.model.access

Enum Role

java.lang.Object

java.lang.Enum<Role>

org.cyclos.model.access.Role

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Role>, SecurityElement

public enum Role
extends java.lang.Enum<Role>
implements SecurityElement

Possible roles for Cyclos actors

Author:

jefferson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADMIN each admin has this role, and may have other more specific roles as well, such as NETWORK_ADMIN
BROKER A broker is someone who can manage non related users.
GLOBAL_ADMIN
GUEST
MEMBER A member role is defined as someone who can login with a username and who cannot manage other non-related users.
NETWORK_ADMIN
OPERATOR
SYSTEM

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isUser() Returns whether this role is a specific user type (admin, member, broker or operator)
boolean	isUserManager() Returns whether this role an user manager (admin or broker)
static Role[]	user() Returns all roles related to user
static Role[]	userAndSpecialAdmins() Returns all roles related to user, plus the special admin roles
static Role[]	userManager() Returns all roles which manages other users
static Role	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Role[]	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

GLOBAL_ADMIN

public static final Role GLOBAL_ADMIN

NETWORK_ADMIN

public static final Role NETWORK_ADMIN

ADMIN

public static final Role ADMIN

each admin has this role, and may have other more specific roles as well, such as NETWORK_ADMIN

MEMBER

public static final Role MEMBER

A member role is defined as someone who can login with a username and who cannot manage other non-related users. A member can manage operators, but operators are related users.

BROKER

public static final Role BROKER

A broker is someone who can manage non related users.

OPERATOR

public static final Role OPERATOR

SYSTEM

public static final Role SYSTEM

GUEST

public static final Role GUEST

Method Detail

values

public static Role[] 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 (Role c : Role.values())
    System.out.println(c);

Returns:

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

valueOf

public static Role 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

user

public static Role[] user()

Returns all roles related to user

userAndSpecialAdmins

public static Role[] userAndSpecialAdmins()

Returns all roles related to user, plus the special admin roles

userManager

public static Role[] userManager()

Returns all roles which manages other users

isUser

public boolean isUser()

Returns whether this role is a specific user type (admin, member, broker or operator)

isUserManager

public boolean isUserManager()

Returns whether this role an user manager (admin or broker)