AbstractRole (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- org.apache.catalina.users.AbstractRole

All Implemented Interfaces:

Principal, Role

Direct Known Subclasses:

MemoryRole
```
public abstract class AbstractRole
extends Object
implements Role
```
Convenience base class for Role implementations.

Since:

4.1

Author:

Craig R. McClanahan

Field Summary

Fields
Modifier and Type Field and Description

protected String description
The description of this Role.

protected String rolename
The role name of this Role.

Fields
Modifier and Type	Field and Description
`protected String`	`description` The description of this Role.
`protected String`	`rolename` The role name of this Role.

Constructor Summary

Constructors
Constructor and Description

AbstractRole()

Constructors
Constructor and Description
`AbstractRole()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Return the description of this role.
`String`	`getName()` Make the principal name the same as the role name.
`String`	`getRolename()` Return the role name of this role, which must be unique within the scope of a `UserDatabase`.
`abstract UserDatabase`	`getUserDatabase()` Return the `UserDatabase` within which this Role is defined.
`void`	`setDescription(String description)` Set the description of this role.
`void`	`setRolename(String rolename)` Set the role name of this role, which must be unique within the scope of a `UserDatabase`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.security.Principal
equals, hashCode, toString

- Field Detail
  - description
```
protected String description
```
    The description of this Role.
  - rolename
```
protected String rolename
```
    The role name of this Role.
- Constructor Detail
  - AbstractRole
```
public AbstractRole()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Return the description of this role.
    
    Specified by:
    
    getDescription in interface Role
    
    Returns:
    the description of this role.
  - setDescription
```
public void setDescription(String description)
```
    Set the description of this role.
    
    Specified by:
    
    setDescription in interface Role
    
    Parameters:
    description - The new description
  - getRolename
```
public String getRolename()
```
    Return the role name of this role, which must be unique within the scope of a UserDatabase.
    
    Specified by:
    
    getRolename in interface Role
    
    Returns:
    the role name of this role, which must be unique within the scope of a UserDatabase.
  - setRolename
```
public void setRolename(String rolename)
```
    Set the role name of this role, which must be unique within the scope of a UserDatabase.
    
    Specified by:
    
    setRolename in interface Role
    
    Parameters:
    rolename - The new role name
  - getUserDatabase
```
public abstract UserDatabase getUserDatabase()
```
    Return the UserDatabase within which this Role is defined.
    
    Specified by:
    
    getUserDatabase in interface Role
    
    Returns:
    the UserDatabase within which this Role is defined.
  - getName
```
public String getName()
```
    Make the principal name the same as the role name.
    
    Specified by:
    
    getName in interface Principal

Class AbstractRole

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.security.Principal

Field Detail

description

rolename

Constructor Detail

AbstractRole

Method Detail

getDescription

setDescription

getRolename

setRolename

getUserDatabase

getName