java.lang.Object
- org.jboss.hal.config.Role

All Implemented Interfaces:

org.jboss.hal.spi.NamedObject
```
public class Role
extends Object
implements org.jboss.hal.spi.NamedObject
```
A standard or scoped role used when RBAC is turned on.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Role.Type

Field Summary

Fields
Modifier and Type	Field	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 Description

Role(String name)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	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()`
`void`	`setIncludeAll(boolean includeAll)`
`String`	`toString()`

Methods inherited from class java.lang.Object
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
```
public Role(String name)
```
  - Role
```
public Role(String name,
            Role baseRole,
            Role.Type type,
            Iterable<String> scope)
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
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
```
public String getId()
```
    Returns:
    
    the unique ID of this role.
  - isStandard
```
public boolean isStandard()
```
    Returns:
    
    true if this is a standard role, false otherwise.
  - isScoped
```
public boolean isScoped()
```
    Returns:
    
    true if this is a scoped role, false otherwise.
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.jboss.hal.spi.NamedObject
    
    Returns:
    
    the name of this role.
  - getBaseRole
```
public Role getBaseRole()
```
    Returns:
    
    the base role if this is a scoped role, null otherwise.
  - getType
```
public Role.Type getType()
```
  - getScope
```
public SortedSet<String> getScope()
```
  - isIncludeAll
```
public boolean isIncludeAll()
```
  - setIncludeAll
```
public void setIncludeAll(boolean includeAll)
```

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

Class Role

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADMINISTRATOR

AUDITOR

DEPLOYER

MAINTAINER

MONITOR

OPERATOR

SUPER_USER

Constructor Detail

Role

Role

Method Detail

equals

hashCode

toString

getId

isStandard

isScoped

getName

getBaseRole

getType

getScope

isIncludeAll

setIncludeAll