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 Summary
FieldsModifier 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.AbstractUser
fullName, password, username -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd a newGroupto those this user belongs to.voidAdd aRoleto those assigned specifically to this user.booleangetRoles()inthashCode()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.Methods inherited from class org.apache.catalina.users.AbstractUser
getFullName, getName, getPassword, getUsername
-
Field Details
-
database
TheUserDatabasethat owns this user. -
groups
The set ofGroups that this user is a member of. -
roles
The set ofRoles associated with this user.
-
-
Method Details
-
getGroups
- Returns:
- the set of
Groups to which this user belongs.
-
getRoles
- Returns:
- the set of
Roles assigned specifically to this user.
-
getUserDatabase
- Returns:
- the
UserDatabasewithin which this User is defined.
-
addGroup
Description copied from interface:UserAdd a newGroupto those this user belongs to.- Parameters:
group- The new group
-
addRole
Description copied from interface:UserAdd aRoleto those assigned specifically to this user.- Parameters:
role- The new role
-
isInGroup
Description copied from interface:UserIs this user in the specifiedGroup?- Parameters:
group- The group to check- Returns:
trueif the user is in the specified group
-
isInRole
Description copied from interface:UserIs this user specifically assigned the specifiedRole? This method does NOT check for roles inherited based onGroupmembership.- Parameters:
role- The role to check- Returns:
trueif the user has the specified role
-
removeGroup
Description copied from interface:UserRemove aGroupfrom those this user belongs to.- Parameters:
group- The old group
-
removeGroups
public void removeGroups()Description copied from interface:UserRemove allGroups from those this user belongs to. -
removeRole
Description copied from interface:UserRemove aRolefrom those assigned to this user.- Parameters:
role- The old role
-
removeRoles
public void removeRoles()Description copied from interface:UserRemove allRoles from those assigned to this user. -
setFullName
Description copied from interface:UserSet the full name of this user.- Specified by:
setFullNamein interfaceUser- Overrides:
setFullNamein classAbstractUser- Parameters:
fullName- The new full name
-
setPassword
Description copied from interface:UserSet 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 interfaceUser- Overrides:
setPasswordin classAbstractUser- Parameters:
password- The new logon password
-
setUsername
Description copied from interface:UserSet the logon username of this user, which must be unique within the scope of aUserDatabase.- Specified by:
setUsernamein interfaceUser- Overrides:
setUsernamein classAbstractUser- Parameters:
username- The new logon username
-
equals
-
hashCode
public int hashCode()
-