| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface User
Abstract representation of a user in a UserDatabase.  Each user
 is optionally associated with a set of Groups through which he or
 she inherits additional security roles, and is optionally assigned a set
 of specific Roles.
| Method Summary | |
|---|---|
|  void | addGroup(Group group)Add a new Groupto those this user belongs to. | 
|  void | addRole(Role role)Add a Roleto those assigned specifically to this user. | 
|  java.lang.String | getFullName()Return the full name of this user. | 
|  java.util.Iterator | getGroups()Return the set of Groups to which this user belongs. | 
|  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. | 
|  java.util.Iterator | getRoles()Return the set of Roles assigned specifically to this user. | 
|  UserDatabase | getUserDatabase()Return the UserDatabasewithin which this User is defined. | 
|  java.lang.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? | 
|  void | removeGroup(Group group)Remove a Groupfrom those this user belongs to. | 
|  void | removeGroups()Remove all Groups from those this user belongs to. | 
|  void | removeRole(Role role)Remove a Rolefrom those assigned to this user. | 
|  void | removeRoles()Remove all Roles from those assigned to this user. | 
|  void | setFullName(java.lang.String fullName)Set the full name of this user. | 
|  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. | 
|  void | setUsername(java.lang.String username)Set the logon username of this user, which must be unique within the scope of a UserDatabase. | 
| Methods inherited from interface java.security.Principal | 
|---|
| equals, getName, hashCode, toString | 
| Method Detail | 
|---|
java.lang.String getFullName()
void setFullName(java.lang.String fullName)
fullName - The new full namejava.util.Iterator getGroups()
Groups to which this user belongs.
java.lang.String getPassword()
{md5}xxxxx.
void setPassword(java.lang.String password)
{md5}xxxxx.
password - The new logon passwordjava.util.Iterator getRoles()
Roles assigned specifically to this user.
UserDatabase getUserDatabase()
UserDatabase within which this User is defined.
java.lang.String getUsername()
UserDatabase.
void setUsername(java.lang.String username)
UserDatabase.
username - The new logon usernamevoid addGroup(Group group)
Group to those this user belongs to.
group - The new groupvoid addRole(Role role)
Role to those assigned specifically to this user.
role - The new roleboolean isInGroup(Group group)
Group?
group - The group to checkboolean isInRole(Role role)
Role?  This
 method does NOT check for roles inherited based on
 Group membership.
role - The role to checkvoid removeGroup(Group group)
Group from those this user belongs to.
group - The old groupvoid removeGroups()
Groups from those this user belongs to.
void removeRole(Role role)
Role from those assigned to this user.
role - The old rolevoid removeRoles()
Roles from those assigned to this user.
| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||