Package org.apache.catalina.users
Class AbstractUser
- java.lang.Object
- 
- org.apache.catalina.users.AbstractUser
 
- 
- All Implemented Interfaces:
- java.security.Principal,- User
 - Direct Known Subclasses:
- GenericUser
 
 public abstract class AbstractUser extends java.lang.Object implements User Convenience base class for Userimplementations.- Since:
- 4.1
- Author:
- Craig R. McClanahan
 
- 
- 
Constructor SummaryConstructors Constructor Description AbstractUser()
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidaddGroup(Group group)Add a newGroupto those this user belongs to.abstract voidaddRole(Role role)Add a newRoleto those assigned specifically to this user.java.lang.StringgetFullName()Return the full name of this user.abstract java.util.Iterator<Group>getGroups()Return the set ofGroups to which this user belongs.java.lang.StringgetName()Make the principal name the same as the group name.java.lang.StringgetPassword()Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as{md5}xxxxx.abstract java.util.Iterator<Role>getRoles()Return the set ofRoles assigned specifically to this user.java.lang.StringgetUsername()Return the logon username of this user, which must be unique within the scope of aUserDatabase.abstract booleanisInGroup(Group group)Is this user in the specifiedGroup?abstract booleanisInRole(Role role)Is this user specifically assigned the specifiedRole?abstract voidremoveGroup(Group group)Remove aGroupfrom those this user belongs to.abstract voidremoveGroups()Remove allGroups from those this user belongs to.abstract voidremoveRole(Role role)Remove aRolefrom those assigned to this user.abstract voidremoveRoles()Remove allRoles from those assigned to this user.voidsetFullName(java.lang.String fullName)Set the full name of this user.voidsetPassword(java.lang.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(java.lang.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, wait
 - 
Methods inherited from interface org.apache.catalina.UsergetUserDatabase
 
- 
 
- 
- 
- 
Method Detail- 
getFullNamepublic java.lang.String getFullName() Return the full name of this user.- Specified by:
- getFullNamein interface- User
- Returns:
- the full name of this user.
 
 - 
setFullNamepublic void setFullName(java.lang.String fullName) Set the full name of this user.- Specified by:
- setFullNamein interface- User
- Parameters:
- fullName- The new full name
 
 - 
getGroupspublic abstract java.util.Iterator<Group> getGroups() Return the set ofGroups to which this user belongs.
 - 
getPasswordpublic java.lang.String getPassword() Return 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.
 
 - 
setPasswordpublic void setPassword(java.lang.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.- Specified by:
- setPasswordin interface- User
- Parameters:
- password- The new logon password
 
 - 
getRolespublic abstract java.util.Iterator<Role> getRoles() Return the set ofRoles assigned specifically to this user.
 - 
getUsernamepublic java.lang.String getUsername() Return 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.
 
 - 
setUsernamepublic void setUsername(java.lang.String username) Set 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
 
 - 
addRolepublic abstract void addRole(Role role) Add a newRoleto those assigned specifically to this user.
 - 
isInRolepublic abstract boolean isInRole(Role role) 
 - 
removeGrouppublic abstract void removeGroup(Group group) Remove 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
 
 - 
removeRolepublic abstract void removeRole(Role role) Remove 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
 
 - 
getNamepublic java.lang.String getName() Make the principal name the same as the group name.- Specified by:
- getNamein interface- java.security.Principal
 
 
- 
 
-