|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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 Group to those this user belongs to. |
void |
addRole(Role role)
Add a Role to 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 UserDatabase within 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 Group from those this user belongs to. |
void |
removeGroups()
Remove all Groups from those this user belongs to. |
void |
removeRole(Role role)
Remove a Role from 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 |
public java.lang.String getFullName()
public void setFullName(java.lang.String fullName)
fullName - The new full namepublic java.util.Iterator getGroups()
Groups to which this user belongs.
public java.lang.String getPassword()
{md5}xxxxx.
public void setPassword(java.lang.String password)
{md5}xxxxx.
password - The new logon passwordpublic java.util.Iterator getRoles()
Roles assigned specifically to this user.
public UserDatabase getUserDatabase()
UserDatabase within which this User is defined.
public java.lang.String getUsername()
UserDatabase.
public void setUsername(java.lang.String username)
UserDatabase.
username - The new logon usernamepublic void addGroup(Group group)
Group to those this user belongs to.
group - The new grouppublic void addRole(Role role)
Role to those assigned specifically to this user.
role - The new rolepublic boolean isInGroup(Group group)
Group?
group - The group to checkpublic boolean isInRole(Role role)
Role? This
method does NOT check for roles inherited based on
Group membership.
role - The role to checkpublic void removeGroup(Group group)
Group from those this user belongs to.
group - The old grouppublic void removeGroups()
Groups from those this user belongs to.
public void removeRole(Role role)
Role from those assigned to this user.
role - The old rolepublic void removeRoles()
Roles from those assigned to this user.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||