org.apache.catalina

Interface User

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.

Since: 4.1

Version: $Revision: 467222 $ $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Craig R. McClanahan

Method Summary
voidaddGroup(Group group)
Add a new Group to those this user belongs to.
voidaddRole(Role role)
Add a Role to those assigned specifically to this user.
StringgetFullName()
Return the full name of this user.
IteratorgetGroups()
Return the set of Groups to which this user belongs.
StringgetPassword()
Return the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded by curly braces, such as {md5}xxxxx.
IteratorgetRoles()
Return the set of Roles assigned specifically to this user.
UserDatabasegetUserDatabase()
Return the UserDatabase within which this User is defined.
StringgetUsername()
Return the logon username of this user, which must be unique within the scope of a UserDatabase.
booleanisInGroup(Group group)
Is this user in the specified Group?
booleanisInRole(Role role)
Is this user specifically assigned the specified Role?
voidremoveGroup(Group group)
Remove a Group from those this user belongs to.
voidremoveGroups()
Remove all Groups from those this user belongs to.
voidremoveRole(Role role)
Remove a Role from those assigned to this user.
voidremoveRoles()
Remove all Roles from those assigned to this user.
voidsetFullName(String fullName)
Set the full name of this user.
voidsetPassword(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.
voidsetUsername(String username)
Set the logon username of this user, which must be unique within the scope of a UserDatabase.

Method Detail

addGroup

public void addGroup(Group group)
Add a new Group to those this user belongs to.

Parameters: group The new group

addRole

public void addRole(Role role)
Add a Role to those assigned specifically to this user.

Parameters: role The new role

getFullName

public String getFullName()
Return the full name of this user.

getGroups

public Iterator getGroups()
Return the set of Groups 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 Roles assigned specifically to this user.

getUserDatabase

public UserDatabase getUserDatabase()
Return the UserDatabase within which this User is defined.

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?

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.

Parameters: role The role to check

removeGroup

public void removeGroup(Group group)
Remove a Group from those this user belongs to.

Parameters: group The old group

removeGroups

public void removeGroups()
Remove all Groups from those this user belongs to.

removeRole

public void removeRole(Role role)
Remove a Role from those assigned to this user.

Parameters: role The old role

removeRoles

public void removeRoles()
Remove all Roles from those assigned to this user.

setFullName

public void setFullName(String fullName)
Set the full name of this 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.

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.

Parameters: username The new logon username

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.