Interface User
- All Superinterfaces:
Principal
- All Known Implementing Classes:
AbstractUser
,GenericUser
,MemoryUser
Abstract representation of a user in a
UserDatabase
. Each user is optionally associated with a set of
Group
s through which they inherit additional security roles, and is optionally assigned a set of specific
Role
s.- Since:
- 4.1
- Author:
- Craig R. McClanahan
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a newGroup
to those this user belongs to.void
Add aRole
to those assigned specifically to this user.getRoles()
boolean
Is this user in the specifiedGroup
?boolean
Is this user specifically assigned the specifiedRole
?void
removeGroup
(Group group) Remove aGroup
from those this user belongs to.void
Remove allGroup
s from those this user belongs to.void
removeRole
(Role role) Remove aRole
from those assigned to this user.void
Remove allRole
s 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 aUserDatabase
.
-
Method Details
-
getFullName
String getFullName()- Returns:
- the full name of this user.
-
setFullName
Set the full name of this user.- Parameters:
fullName
- The new full name
-
getGroups
-
getPassword
String getPassword()- Returns:
- the logon password of this user, optionally prefixed with the identifier of an encoding scheme surrounded
by curly braces, such as
{md5}xxxxx
.
-
setPassword
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
-
getRoles
-
getUserDatabase
UserDatabase getUserDatabase()- Returns:
- the
UserDatabase
within which this User is defined.
-
getUsername
String getUsername()- Returns:
- the logon username of this user, which must be unique within the scope of a
UserDatabase
.
-
setUsername
Set the logon username of this user, which must be unique within the scope of aUserDatabase
.- Parameters:
username
- The new logon username
-
addGroup
-
addRole
-
isInGroup
-
isInRole
-
removeGroup
-
removeGroups
void removeGroups()Remove allGroup
s from those this user belongs to. -
removeRole
-
removeRoles
void removeRoles()Remove allRole
s from those assigned to this user.
-