Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: User [javadoc | source]

All Implemented Interfaces:
    Principal

All Known Implementing Classes:
    MemoryUser, AbstractUser

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.

Method from org.apache.catalina.User Summary:
addGroup,   addRole,   getFullName,   getGroups,   getPassword,   getRoles,   getUserDatabase,   getUsername,   isInGroup,   isInRole,   removeGroup,   removeGroups,   removeRole,   removeRoles,   setFullName,   setPassword,   setUsername
Method from org.apache.catalina.User Detail:
 public  void addGroup(Group group)
    Add a new Group to those this user belongs to.
 public  void addRole(Role role)
    Add a Role to those assigned specifically to this user.
 public String getFullName()
    Return the full name of this user.
 public Iterator getGroups()
    Return the set of Group s to which this user belongs.
 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.
 public Iterator getRoles()
    Return the set of Role s assigned specifically to this user.
 public UserDatabase getUserDatabase()
 public String getUsername()
    Return the logon username of this user, which must be unique within the scope of a UserDatabase .
 public boolean isInGroup(Group group)
    Is this user in the specified Group ?
 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.
 public  void removeGroup(Group group)
    Remove a Group from those this user belongs to.
 public  void removeGroups()
    Remove all Group s from those this user belongs to.
 public  void removeRole(Role role)
    Remove a Role from those assigned to this user.
 public  void removeRoles()
    Remove all Role s from those assigned to this user.
 public  void setFullName(String fullName)
    Set the full name of this user.
 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.
 public  void setUsername(String username)
    Set the logon username of this user, which must be unique within the scope of a UserDatabase .