org.jboss.hal.config

Class Role

java.lang.Object

org.jboss.hal.config.Role

@JsType
public class Role
extends Object

A standard or scoped role used when RBAC is turned on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Role.Type

Field Summary

Fields

Modifier and Type	Field and Description
static Role	ADMINISTRATOR Has all permissions except cannot read or write resources related to the administrative audit logging system.
static Role	AUDITOR Can read anything.
static Role	DEPLOYER Like a Maintainer, but with permission to modify persistent configuration constrained to resources that are considered to be "application resources".
static Role	MAINTAINER Operator permissions, plus can modify the persistent configuration.
static Role	MONITOR A read-only role.
static Role	OPERATOR Monitor permissions, plus can modify runtime state, but cannot modify anything that ends up in the persistent configuration.
static Role	SUPER_USER Has all permissions.

Constructor Summary

Constructors

Constructor and Description
Role(String name)
Role(String name, Role baseRole, Role.Type type, Iterable<String> scope)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Role	getBaseRole()
String	getId()
String	getName()
SortedSet<String>	getScope()
Role.Type	getType()
int	hashCode()
boolean	isIncludeAll()
boolean	isScoped()
boolean	isStandard()
String[]	jsScope()
void	setIncludeAll(boolean includeAll)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADMINISTRATOR

public static final Role ADMINISTRATOR

Has all permissions except cannot read or write resources related to the administrative audit logging system.

AUDITOR

public static final Role AUDITOR

Can read anything. Can only modify the resources related to the administrative audit logging system.

DEPLOYER

public static final Role DEPLOYER

Like a Maintainer, but with permission to modify persistent configuration constrained to resources that are considered to be "application resources". A deployment is an application resource. The messaging server is not. Items like datasources and JMS destinations are not considered to be application resources by default, but this is configurable.

MAINTAINER

public static final Role MAINTAINER

Operator permissions, plus can modify the persistent configuration.

MONITOR

public static final Role MONITOR

A read-only role. Cannot modify any resource.

OPERATOR

public static final Role OPERATOR

Monitor permissions, plus can modify runtime state, but cannot modify anything that ends up in the persistent configuration. Could, for example, restart a server.

SUPER_USER

public static final Role SUPER_USER

Has all permissions. Equivalent to a JBoss AS 7 administrator.

Constructor Detail

Role

@JsIgnore
public Role(@NonNls
                      String name)

Role

@JsIgnore
public Role(@NonNls
                      String name,
                      Role baseRole,
                      Role.Type type,
                      Iterable<String> scope)

Method Detail

equals

@JsIgnore
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@JsIgnore
public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

a string representation of this role.

getId

@JsProperty
public String getId()

Returns:

the unique ID of this role.

isStandard

@JsProperty
public boolean isStandard()

Returns:

true if this is a standard role, false otherwise.

isScoped

@JsProperty
public boolean isScoped()

Returns:

true if this is a scoped role, false otherwise.

getName

@JsProperty
public String getName()

Returns:

the name of this role.

getBaseRole

@JsProperty
public Role getBaseRole()

Returns:

the base role if this is a scoped role, null otherwise.

getType

@JsIgnore
public Role.Type getType()

getScope

@JsIgnore
public SortedSet<String> getScope()

isIncludeAll

@JsIgnore
public boolean isIncludeAll()

setIncludeAll

@JsIgnore
public void setIncludeAll(boolean includeAll)

jsScope

@JsProperty(name="scope")
public String[] jsScope()

Returns:

the scopes if this is a scoped role, an empty array otherwise.