Package org.apache.catalina.users
Class AbstractUser
java.lang.Object
org.apache.catalina.users.AbstractUser
- Direct Known Subclasses:
- GenericUser
Convenience base class for User implementations.
- Since:
- 4.1
- Author:
- Craig R. McClanahan
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionabstract voidAdd a newGroupto those this user belongs to.abstract voidAdd a newRoleto those assigned specifically to this user.Return the full name of this user.Return the set ofGroups to which this user belongs.getName()Make the principal name the same as the group name.Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.getRoles()Return the set ofRoles assigned specifically to this user.Return the logon username of this user, which must be unique within the scope of aUserDatabase.abstract booleanIs this user in the specifiedGroup?abstract booleanIs this user specifically assigned the specifiedRole?abstract voidremoveGroup(Group group) Remove aGroupfrom those this user belongs to.abstract voidRemove allGroups from those this user belongs to.abstract voidremoveRole(Role role) Remove aRolefrom those assigned to this user.abstract 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.Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.UsergetUserDatabase
- 
Field Details- 
fullNameThe full name of this user.
- 
passwordThe logon password of this user.
- 
usernameThe logon username of this user.
 
- 
- 
Constructor Details- 
AbstractUserpublic AbstractUser()
 
- 
- 
Method Details- 
getFullNameReturn the full name of this user.- Specified by:
- getFullNamein interface- User
- Returns:
- the full name of this user.
 
- 
setFullNameSet the full name of this user.- Specified by:
- setFullNamein interface- User
- Parameters:
- fullName- The new full name
 
- 
getGroupsReturn the set ofGroups to which this user belongs.
- 
getPasswordReturn the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.- Specified by:
- getPasswordin interface- User
- Returns:
- the logon password of this user, optionally prefixed with the
 identifier of an encoding scheme surrounded by curly braces, such as
 {md5}xxxxx.
 
- 
setPasswordSet the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.- Specified by:
- setPasswordin interface- User
- Parameters:
- password- The new logon password
 
- 
getRolesReturn the set ofRoles assigned specifically to this user.
- 
getUsernameReturn the logon username of this user, which must be unique within the scope of aUserDatabase.- Specified by:
- getUsernamein interface- User
- Returns:
- the logon username of this user, which must be unique
 within the scope of a UserDatabase.
 
- 
setUsernameSet the logon username of this user, which must be unique within the scope of aUserDatabase.- Specified by:
- setUsernamein interface- User
- Parameters:
- username- The new logon username
 
- 
addGroupAdd a newGroupto those this user belongs to.
- 
addRoleAdd a newRoleto those assigned specifically to this user.
- 
isInGroupIs this user in the specifiedGroup?
- 
isInRole
- 
removeGroupRemove aGroupfrom those this user belongs to.- Specified by:
- removeGroupin interface- User
- Parameters:
- group- The old group
 
- 
removeGroupspublic abstract void removeGroups()Remove allGroups from those this user belongs to.- Specified by:
- removeGroupsin interface- User
 
- 
removeRoleRemove aRolefrom those assigned to this user.- Specified by:
- removeRolein interface- User
- Parameters:
- role- The old role
 
- 
removeRolespublic abstract void removeRoles()Remove allRoles from those assigned to this user.- Specified by:
- removeRolesin interface- User
 
- 
getNameMake the principal name the same as the group name.
 
-