public interface User extends Principal
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.
| Modifier and Type | Method and Description | 
|---|---|
| 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. | 
| String | getFullName() | 
| Iterator<Group> | getGroups() | 
| String | getPassword() | 
| Iterator<Role> | getRoles() | 
| UserDatabase | getUserDatabase() | 
| String | getUsername() | 
| 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(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. | 
String getFullName()
void setFullName(String fullName)
fullName - The new full nameString getPassword()
{md5}xxxxx.void setPassword(String password)
{md5}xxxxx.password - The new logon passwordUserDatabase getUserDatabase()
UserDatabase within which this User is defined.String getUsername()
UserDatabase.void setUsername(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 checktrue if the user is in the specified groupboolean isInRole(Role role)
Role?  This
 method does NOT check for roles inherited based on
 Group membership.role - The role to checktrue if the user has the specified rolevoid 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.Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.