Package org.apache.catalina.users
Class AbstractRole
java.lang.Object
org.apache.catalina.users.AbstractRole
- Direct Known Subclasses:
GenericRole
Convenience base class for Role implementations.
- Since:
- 4.1
- Author:
- Craig R. McClanahan
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturn the description of this role.getName()Make the principal name the same as the role name.Return the role name of this role, which must be unique within the scope of aUserDatabase.abstract UserDatabaseReturn theUserDatabasewithin which this Role is defined.voidsetDescription(String description) Set the description of this role.voidsetRolename(String rolename) Set the role name of this role, which must be unique within the scope of aUserDatabase.
-
Field Details
-
description
The description of this Role. -
rolename
The role name of this Role.
-
-
Constructor Details
-
AbstractRole
public AbstractRole()
-
-
Method Details
-
getDescription
Return the description of this role.- Specified by:
getDescriptionin interfaceRole- Returns:
- the description of this role.
-
setDescription
Set the description of this role.- Specified by:
setDescriptionin interfaceRole- Parameters:
description- The new description
-
getRolename
Return the role name of this role, which must be unique within the scope of aUserDatabase.- Specified by:
getRolenamein interfaceRole- Returns:
- the role name of this role, which must be unique
within the scope of a
UserDatabase.
-
setRolename
Set the role name of this role, which must be unique within the scope of aUserDatabase.- Specified by:
setRolenamein interfaceRole- Parameters:
rolename- The new role name
-
getUserDatabase
Return theUserDatabasewithin which this Role is defined.- Specified by:
getUserDatabasein interfaceRole- Returns:
- the
UserDatabasewithin which this Role is defined.
-
getName
Make the principal name the same as the role name.
-