org.apache.catalina.users

Class AbstractUser

public abstract class AbstractUser extends Object implements User

Convenience base class for User implementations.

Since: 4.1

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

Author: Craig R. McClanahan

Field Summary
protected StringfullName
The full name of this user.
protected Stringpassword
The logon password of this user.
protected Stringusername
The logon username of this user.
Method Summary
abstract voidaddGroup(Group group)
Add a new Group to those this user belongs to.
abstract voidaddRole(Role role)
Add a new Role to those assigned specifically to this user.
StringgetFullName()
Return the full name of this user.
abstract IteratorgetGroups()
Return the set of Groups to which this user belongs.
StringgetName()
Make the principal name the same as the group name.
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.
abstract IteratorgetRoles()
Return the set of Roles assigned specifically to this user.
StringgetUsername()
Return the logon username of this user, which must be unique within the scope of a UserDatabase.
abstract booleanisInGroup(Group group)
Is this user in the specified Group?
abstract booleanisInRole(Role role)
Is this user specifically assigned the specified Role?
abstract voidremoveGroup(Group group)
Remove a Group from those this user belongs to.
abstract voidremoveGroups()
Remove all Groups from those this user belongs to.
abstract voidremoveRole(Role role)
Remove a Role from those assigned to this user.
abstract 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.

Field Detail

fullName

protected String fullName
The full name of this user.

password

protected String password
The logon password of this user.

username

protected String username
The logon username of this user.

Method Detail

addGroup

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

Parameters: group The new group

addRole

public abstract void addRole(Role role)
Add a new 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 abstract Iterator getGroups()
Return the set of Groups to which this user belongs.

getName

public String getName()
Make the principal name the same as the group name.

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 abstract Iterator getRoles()
Return the set of Roles 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 abstract boolean isInGroup(Group group)
Is this user in the specified Group?

Parameters: group The group to check

isInRole

public abstract 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 abstract void removeGroup(Group group)
Remove a Group from those this user belongs to.

Parameters: group The old group

removeGroups

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

removeRole

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

Parameters: role The old role

removeRoles

public abstract 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.