Package org.apache.catalina.users
Class GenericUser<UD extends UserDatabase>
java.lang.Object
org.apache.catalina.users.AbstractUser
org.apache.catalina.users.GenericUser<UD>
- Type Parameters:
- UD- The specific type of UserDase with which this role is associated
- Direct Known Subclasses:
- MemoryUser
Concrete implementation of User for a
 UserDatabase.
- Author:
- Craig R. McClanahan
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final UDTheUserDatabasethat owns this user.protected final CopyOnWriteArrayList<Group>The set ofGroups that this user is a member of.protected final CopyOnWriteArrayList<Role>The set ofRoles associated with this user.Fields inherited from class org.apache.catalina.users.AbstractUserfullName, password, username
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a newGroupto those this user belongs to.voidAdd a newRoleto those assigned specifically to this user.booleanReturn the set ofGroups to which this user belongs.getRoles()Return the set ofRoles assigned specifically to this user.Return theUserDatabasewithin which this User is defined.inthashCode()booleanIs this user in the specified group?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.Methods inherited from class org.apache.catalina.users.AbstractUsergetFullName, getName, getPassword, getUsername
- 
Field Details- 
databaseTheUserDatabasethat owns this user.
- 
groupsThe set ofGroups that this user is a member of.
- 
rolesThe set ofRoles associated with this user.
 
- 
- 
Method Details- 
getGroupsReturn the set ofGroups to which this user belongs.- Specified by:
- getGroupsin interface- User
- Specified by:
- getGroupsin class- AbstractUser
- Returns:
- the set of Groups to which this user belongs.
 
- 
getRolesReturn the set ofRoles assigned specifically to this user.- Specified by:
- getRolesin interface- User
- Specified by:
- getRolesin class- AbstractUser
- Returns:
- the set of Roles assigned specifically to this user.
 
- 
getUserDatabaseReturn theUserDatabasewithin which this User is defined.- Returns:
- the UserDatabasewithin which this User is defined.
 
- 
addGroupAdd a newGroupto those this user belongs to.- Specified by:
- addGroupin interface- User
- Specified by:
- addGroupin class- AbstractUser
- Parameters:
- group- The new group
 
- 
addRoleAdd a newRoleto those assigned specifically to this user.- Specified by:
- addRolein interface- User
- Specified by:
- addRolein class- AbstractUser
- Parameters:
- role- The new role
 
- 
isInGroupIs this user in the specified group?- Specified by:
- isInGroupin interface- User
- Specified by:
- isInGroupin class- AbstractUser
- Parameters:
- group- The group to check
- Returns:
- trueif the user is in the specified group
 
- 
isInRoleIs this user specifically assigned the specifiedRole? This method does NOT check for roles inherited based onGroupmembership.- Specified by:
- isInRolein interface- User
- Specified by:
- isInRolein class- AbstractUser
- Parameters:
- role- The role to check
- Returns:
- trueif the user has the specified role
 
- 
removeGroupRemove aGroupfrom those this user belongs to.- Specified by:
- removeGroupin interface- User
- Specified by:
- removeGroupin class- AbstractUser
- Parameters:
- group- The old group
 
- 
removeGroupspublic void removeGroups()Remove allGroups from those this user belongs to.- Specified by:
- removeGroupsin interface- User
- Specified by:
- removeGroupsin class- AbstractUser
 
- 
removeRoleRemove aRolefrom those assigned to this user.- Specified by:
- removeRolein interface- User
- Specified by:
- removeRolein class- AbstractUser
- Parameters:
- role- The old role
 
- 
removeRolespublic void removeRoles()Remove allRoles from those assigned to this user.- Specified by:
- removeRolesin interface- User
- Specified by:
- removeRolesin class- AbstractUser
 
- 
setFullNameDescription copied from class:AbstractUserSet the full name of this user.- Specified by:
- setFullNamein interface- User
- Overrides:
- setFullNamein class- AbstractUser
- Parameters:
- fullName- The new full name
 
- 
setPasswordDescription copied from class:AbstractUserSet 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
- Overrides:
- setPasswordin class- AbstractUser
- Parameters:
- password- The new logon password
 
- 
setUsernameDescription copied from class:AbstractUserSet the logon username of this user, which must be unique within the scope of aUserDatabase.- Specified by:
- setUsernamein interface- User
- Overrides:
- setUsernamein class- AbstractUser
- Parameters:
- username- The new logon username
 
- 
equals
- 
hashCodepublic int hashCode()
 
-