org.apache.catalina.users

Class AbstractUser

Implemented Interfaces:
Principal, User
Known Direct Subclasses:
MemoryUser

public abstract class AbstractUser
extends java.lang.Object
implements User

Convenience base class for User implementations.

Version:
$Revision: 1.2 $ $Date: 2004/02/27 14:58:50 $

Author:
Craig R. McClanahan

Since:
4.1

Field Summary

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.

Method Summary

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 Groups 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 Roles 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 Groups from those this user belongs to.
void
removeRole(Role role)
Remove a Role from those assigned to this user.
void
removeRoles()
Remove all Roles 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.

Field Details

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.

Method Details

addGroup

public void addGroup(Group group)
Add a new Group to those this user belongs to.
Specified by:
addGroup in interface User

Parameters:
group - The new group


addRole

public void addRole(Role role)
Add a new Role to those assigned specifically to this user.
Specified by:
addRole in interface User

Parameters:
role - The new role


getFullName

public String getFullName()
Return the full name of this user.
Specified by:
getFullName in interface User


getGroups

public Iterator getGroups()
Return the set of Groups to which this user belongs.
Specified by:
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.
Specified by:
getPassword in interface User


getRoles

public Iterator getRoles()
Return the set of Roles assigned specifically to this user.
Specified by:
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.
Specified by:
getUsername in interface User


isInGroup

public boolean isInGroup(Group group)
Is this user in the specified Group?
Specified by:
isInGroup in interface User

Parameters:
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.
Specified by:
isInRole in interface User

Parameters:
role - The role to check


removeGroup

public void removeGroup(Group group)
Remove a Group from those this user belongs to.
Specified by:
removeGroup in interface User

Parameters:
group - The old group


removeGroups

public void removeGroups()
Remove all Groups from those this user belongs to.
Specified by:
removeGroups in interface User


removeRole

public void removeRole(Role role)
Remove a Role from those assigned to this user.
Specified by:
removeRole in interface User

Parameters:
role - The old role


removeRoles

public void removeRoles()
Remove all Roles from those assigned to this user.
Specified by:
removeRoles in interface User


setFullName

public void setFullName(String fullName)
Set the full name of this user.
Specified by:
setFullName in interface User

Parameters:
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.
Specified by:
setPassword in interface User

Parameters:
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.
Specified by:
setUsername in interface User

Parameters:
username - The new logon username


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.