org.apache.catalina
Interface User
- Principal
- AbstractUser, MemoryUser
public interface User
extends Principal
Abstract representation of a user in a
UserDatabase
. Each user
is optionally associated with a set of
Group
s through which he or
she inherits additional security roles, and is optionally assigned a set
of specific
Role
s.
Version:
- Craig R. McClanahan
- 4.1
void | addGroup(Group group) - Add a new
Group to those this user belongs to.
|
void | addRole(Role role) - Add a
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 | 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.
|
UserDatabase | getUserDatabase() - Return the
UserDatabase within which this User is defined.
|
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 .
|
addGroup
public void addGroup(Group group)
Add a new
Group
to those this user belongs to.
group
- The new group
addRole
public void addRole(Role role)
Add a
Role
to those assigned specifically to this user.
role
- The new role
getFullName
public String getFullName()
Return the full name of this user.
getGroups
public Iterator getGroups()
Return the set of
Group
s to which this user belongs.
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
.
getRoles
public Iterator getRoles()
Return the set of
Role
s assigned specifically to this user.
getUsername
public String getUsername()
Return the logon username of this user, which must be unique
within the scope of a
UserDatabase
.
isInGroup
public boolean isInGroup(Group group)
Is this user in the specified
Group
?
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.
role
- The role to check
removeGroup
public void removeGroup(Group group)
Remove a
Group
from those this user belongs to.
group
- The old group
removeGroups
public void removeGroups()
Remove all
Group
s from those this user belongs to.
removeRole
public void removeRole(Role role)
Remove a
Role
from those assigned to this user.
role
- The old role
removeRoles
public void removeRoles()
Remove all
Role
s from those assigned to this user.
setFullName
public void setFullName(String fullName)
Set the full name of this 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
.
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
.
username
- The new logon username
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.