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 Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier 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.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.catalina.User
getUserDatabase
-
Field Details
-
fullName
The full name of this user. -
password
The logon password of this user. -
username
The logon username of this user.
-
-
Constructor Details
-
AbstractUser
public AbstractUser()
-
-
Method Details
-
getFullName
Return the full name of this user.- Specified by:
getFullNamein interfaceUser- Returns:
- the full name of this user.
-
setFullName
Set the full name of this user.- Specified by:
setFullNamein interfaceUser- Parameters:
fullName- The new full name
-
getGroups
Return the set ofGroups to which this user belongs. -
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 interfaceUser- 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.- Specified by:
setPasswordin interfaceUser- Parameters:
password- The new logon password
-
getRoles
Return the set ofRoles assigned specifically to this user. -
getUsername
Return the logon username of this user, which must be unique within the scope of aUserDatabase.- Specified by:
getUsernamein interfaceUser- 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.- Specified by:
setUsernamein interfaceUser- Parameters:
username- The new logon username
-
addGroup
Add a newGroupto those this user belongs to. -
addRole
Add a newRoleto those assigned specifically to this user. -
isInGroup
Is this user in the specifiedGroup? -
isInRole
-
removeGroup
Remove aGroupfrom those this user belongs to.- Specified by:
removeGroupin interfaceUser- Parameters:
group- The old group
-
removeGroups
public abstract void removeGroups()Remove allGroups from those this user belongs to.- Specified by:
removeGroupsin interfaceUser
-
removeRole
Remove aRolefrom those assigned to this user.- Specified by:
removeRolein interfaceUser- Parameters:
role- The old role
-
removeRoles
public abstract void removeRoles()Remove allRoles from those assigned to this user.- Specified by:
removeRolesin interfaceUser
-
getName
Make the principal name the same as the group name.
-