|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A repository user.
Method Summary | |
void |
addToRole(Role role)
Adds the User to the specified Role role. |
void |
clearRoles()
Clears all roles for this user and sets the default role to null. |
long[] |
getAllRoleIds()
Returns the ids of the roles to which the user belongs. |
Roles |
getAllRoles()
Returns the Roles to which the user belongs |
java.lang.String |
getAuthenticationScheme()
|
java.lang.String |
getConfirmKey()
|
Role |
getDefaultRole()
Gets the default role for this user, can return null if there is no default role assigned. |
java.lang.String |
getDisplayName()
Returns either the concatenation of firstName and lastName, if at least one of those has a value, or otherwise the login. |
java.lang.String |
getEmail()
Gets the email address of this user, or null if not assigned. |
java.lang.String |
getFirstName()
Gets the first name of the user, could be null. |
long |
getId()
Returns the user id. |
java.util.Date |
getLastModified()
|
long |
getLastModifier()
Gets the user id of the last modifier. |
java.lang.String |
getLastName()
Gets the last name of the user, could be null. |
java.lang.String |
getLogin()
Returns the user login. |
org.outerx.daisy.x10.PublicUserInfoDocument |
getPublicUserInfo()
|
long |
getUpdateCount()
|
org.outerx.daisy.x10.UserDocument |
getXml()
Gets the XML representation of this object. |
boolean |
hasRole(long roleId)
Returns true if the user belongs to the specified role. |
boolean |
isConfirmed()
|
boolean |
isUpdateableByUser()
Returns true if the user to who this user object corresponds can update this object. |
void |
removeFromRole(Role role)
Remove the User from the specified Role role. |
void |
save()
Persist this User to a data store. |
void |
setAuthenticationScheme(java.lang.String schemeName)
|
void |
setConfirmed(boolean confirmed)
|
void |
setConfirmKey(java.lang.String confirmKey)
|
void |
setDefaultRole(Role role)
Sets this User's default role. |
void |
setEmail(java.lang.String emailAddress)
Sets this User's e-mail. |
void |
setFirstName(java.lang.String firstName)
Sets the first name of the user (can be null). |
void |
setLastName(java.lang.String lastName)
Sets the last name of the user (can be null). |
void |
setLogin(java.lang.String loginName)
Sets the user login string. |
void |
setPassword(java.lang.String password)
Sets the password for this user. |
void |
setUpdateableByUser(boolean updateableByUser)
|
Method Detail |
public void setDefaultRole(Role role) throws UserManagementException
If the user is not yet associated with this role
(via addToRole(Role)
), then this will be
done implicitely.
You can specify null to unset the default role.
A default role is optional, if a user does not have a default role, then the authentication code will itself decide which role(s) to take as default.
UserManagementException
public Role getDefaultRole()
public void addToRole(Role role)
role
- the Role to add the user topublic void removeFromRole(Role role)
role
- the Role to remove the user frompublic Roles getAllRoles()
public long[] getAllRoleIds()
public void setPassword(java.lang.String password)
For security reasons, getPassword is not provided.
public void setEmail(java.lang.String emailAddress)
emailAddress
- allowed to be nullpublic java.lang.String getEmail()
public java.lang.String getLogin()
public void setLogin(java.lang.String loginName)
public long getId()
public void setFirstName(java.lang.String firstName)
public void setLastName(java.lang.String lastName)
public java.lang.String getFirstName()
public java.lang.String getLastName()
public java.lang.String getDisplayName()
public void save() throws RepositoryException
RepositoryException
public java.util.Date getLastModified()
public long getLastModifier()
public org.outerx.daisy.x10.UserDocument getXml()
public void clearRoles()
public boolean hasRole(long roleId)
public boolean isUpdateableByUser()
public void setUpdateableByUser(boolean updateableByUser)
isUpdateableByUser()
public boolean isConfirmed()
public void setConfirmed(boolean confirmed)
public java.lang.String getConfirmKey()
public void setConfirmKey(java.lang.String confirmKey)
public java.lang.String getAuthenticationScheme()
public void setAuthenticationScheme(java.lang.String schemeName)
public long getUpdateCount()
public org.outerx.daisy.x10.PublicUserInfoDocument getPublicUserInfo()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |