org.apache.catalina.users
Class AbstractUser
java.lang.Object
org.apache.catalina.users.AbstractUser
- Principal, User
public abstract class AbstractUser
extends java.lang.Object
Convenience base class for
User
implementations.
Version:
- Craig R. McClanahan
- 4.1
protected String | fullName - The full name of this user.
|
protected String | password - The logon password of this user.
|
protected String | username - The logon username of this user.
|
void | addGroup(Group group) - Add a new
Group to those this user belongs to.
|
void | addRole(Role role) - Add a new
Role to those assigned specifically to this user.
|
String | getFullName() - Return the full name of this user.
|
Iterator | getGroups() - Return the set of
Group s to which this user belongs.
|
String | getName() - Make the principal name the same as the group name.
|
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 .
|
Iterator | getRoles() - Return the set of
Role s assigned specifically to this user.
|
String | getUsername() - Return the logon username of this user, which must be unique
within the scope of a
UserDatabase .
|
boolean | isInGroup(Group group) - Is this user in the specified
Group ?
|
boolean | isInRole(Role role) - Is this user specifically assigned the specified
Role ? This
method does NOT check for roles inherited based on
Group membership.
|
void | removeGroup(Group group) - Remove a
Group from those this user belongs to.
|
void | removeGroups() - Remove all
Group s from those this user belongs to.
|
void | removeRole(Role role) - Remove a
Role from those assigned to this user.
|
void | removeRoles() - Remove all
Role s from those assigned to this user.
|
void | setFullName(String fullName) - Set the full name of this user.
|
void | setPassword(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 .
|
void | setUsername(String username) - Set the logon username of this user, which must be unique within
the scope of a
UserDatabase .
|
fullName
protected String fullName
The full name of this user.
password
protected String password
The logon password of this user.
username
protected String username
The logon username of this user.
addGroup
public void addGroup(Group group)
Add a new
Group
to those this user belongs to.
- addGroup in interface User
group
- The new group
addRole
public void addRole(Role role)
Add a new
Role
to those assigned specifically to this user.
- addRole in interface User
role
- The new role
getFullName
public String getFullName()
Return the full name of this user.
- getFullName in interface User
getGroups
public Iterator getGroups()
Return the set of
Group
s to which this user belongs.
- getGroups in interface User
getName
public String getName()
Make the principal name the same as the group name.
getPassword
public 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
.
- getPassword in interface User
getRoles
public Iterator getRoles()
Return the set of
Role
s assigned specifically to this user.
- getRoles in interface User
getUsername
public String getUsername()
Return the logon username of this user, which must be unique
within the scope of a UserDatabase
.
- getUsername in interface User
isInGroup
public boolean isInGroup(Group group)
Is this user in the specified
Group
?
- isInGroup in interface User
group
- The group to check
isInRole
public boolean isInRole(Role role)
Is this user specifically assigned the specified
Role
? This
method does
NOT check for roles inherited based on
Group
membership.
- isInRole in interface User
role
- The role to check
removeGroup
public void removeGroup(Group group)
Remove a
Group
from those this user belongs to.
- removeGroup in interface User
group
- The old group
removeGroups
public void removeGroups()
Remove all
Group
s from those this user belongs to.
- removeGroups in interface User
removeRole
public void removeRole(Role role)
Remove a
Role
from those assigned to this user.
- removeRole in interface User
role
- The old role
removeRoles
public void removeRoles()
Remove all
Role
s from those assigned to this user.
- removeRoles in interface User
setFullName
public void setFullName(String fullName)
Set the full name of this user.
- setFullName in interface User
fullName
- The new full name
setPassword
public void setPassword(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
.
- setPassword in interface User
password
- The new logon password
setUsername
public void setUsername(String username)
Set the logon username of this user, which must be unique within
the scope of a UserDatabase
.
- setUsername in interface User
username
- The new logon username
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.