Package org.apache.catalina
Interface Role
-
- All Superinterfaces:
java.security.Principal
- All Known Implementing Classes:
AbstractRole,GenericRole,MemoryRole
public interface Role extends java.security.PrincipalAbstract representation of a security role, suitable for use in environments like JAAS that want to deal with
Principals.- Since:
- 4.1
- Author:
- Craig R. McClanahan
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetDescription()java.lang.StringgetRolename()UserDatabasegetUserDatabase()voidsetDescription(java.lang.String description)Set the description of this role.voidsetRolename(java.lang.String rolename)Set the role name of this role, which must be unique within the scope of aUserDatabase.
-
-
-
Method Detail
-
getDescription
java.lang.String getDescription()
- Returns:
- the description of this role.
-
setDescription
void setDescription(java.lang.String description)
Set the description of this role.- Parameters:
description- The new description
-
getRolename
java.lang.String getRolename()
- Returns:
- the role name of this role, which must be unique
within the scope of a
UserDatabase.
-
setRolename
void setRolename(java.lang.String rolename)
Set the role name of this role, which must be unique within the scope of aUserDatabase.- Parameters:
rolename- The new role name
-
getUserDatabase
UserDatabase getUserDatabase()
- Returns:
- the
UserDatabasewithin which this Role is defined.
-
-