Package org.apache.catalina
Interface User
- All Superinterfaces:
Principal
- All Known Implementing Classes:
AbstractUser,GenericUser,MemoryUser
Abstract representation of a user in a
UserDatabase. Each user is
optionally associated with a set of Groups through which they inherit
additional security roles, and is optionally assigned a set of specific
Roles.- Since:
- 4.1
- Author:
- Craig R. McClanahan
-
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a newGroupto those this user belongs to.voidAdd aRoleto those assigned specifically to this user.getRoles()booleanIs this user in the specifiedGroup?booleanIs this user specifically assigned the specifiedRole?voidremoveGroup(Group group) Remove aGroupfrom those this user belongs to.voidRemove allGroups from those this user belongs to.voidremoveRole(Role role) Remove aRolefrom those assigned to this user.voidRemove allRoles from those assigned to this user.voidsetFullName(String fullName) Set the full name of this user.voidsetPassword(String password) Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.voidsetUsername(String username) Set the logon username of this user, which must be unique within the scope of aUserDatabase.
-
Method Details
-
getFullName
String getFullName()- Returns:
- the full name of this user.
-
setFullName
Set the full name of this user.- Parameters:
fullName- The new full name
-
getGroups
-
getPassword
String getPassword()- Returns:
- the logon password of this user, optionally prefixed with the
identifier of an encoding scheme surrounded by curly braces, such as
{md5}xxxxx.
-
setPassword
Set the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.- Parameters:
password- The new logon password
-
getRoles
-
getUserDatabase
UserDatabase getUserDatabase()- Returns:
- the
UserDatabasewithin which this User is defined.
-
getUsername
String getUsername()- Returns:
- the logon username of this user, which must be unique
within the scope of a
UserDatabase.
-
setUsername
Set the logon username of this user, which must be unique within the scope of aUserDatabase.- Parameters:
username- The new logon username
-
addGroup
-
addRole
-
isInGroup
-
isInRole
-
removeGroup
-
removeGroups
void removeGroups()Remove allGroups from those this user belongs to. -
removeRole
-
removeRoles
void removeRoles()Remove allRoles from those assigned to this user.
-