|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserManager
Manager for all things user related.
Method Summary | |
---|---|
Role |
createRole(java.lang.String roleName)
Creates a new Role. |
User |
createUser(java.lang.String login)
Creates a new User. |
void |
deleteRole(long roleId)
Deletes the Role with data store id roleId |
void |
deleteUser(long userId)
Deletes the User with data store id userId |
AuthenticationSchemeInfos |
getAuthenticationSchemes()
|
org.outerx.daisy.x10.PublicUserInfoDocument |
getPublicUserInfo(long userId)
Returns the publicly available information for a user. |
org.outerx.daisy.x10.PublicUserInfosDocument |
getPublicUserInfos()
Returns the public information of all users. |
Role |
getRole(long roleId,
boolean updateable)
Return the Role object which is identified by data store id roleId |
Role |
getRole(java.lang.String roleName,
boolean updateable)
Return the Role object which is identified by the specified roleName |
java.lang.String |
getRoleDisplayName(long roleId)
Retrieves the name of a role, using the user cache for quick access. |
Roles |
getRoles()
Returns all available roles. |
User |
getUser(long userId,
boolean updateable)
Return the User object which is identified by data store id userId. |
User |
getUser(java.lang.String userLogin,
boolean updateable)
Return the User object which is identified by the specified userLogin |
java.lang.String |
getUserDisplayName(long userId)
Retrieves the display name of a user, using the user cache for quick access. |
long |
getUserId(java.lang.String login)
Retrieves the id of a user based on its login. |
long[] |
getUserIds()
|
java.lang.String |
getUserLogin(long userId)
Retrieves the login of a user. |
Users |
getUsers()
Returns all available users. |
Users |
getUsersByEmail(java.lang.String email)
|
Method Detail |
---|
Users getUsers() throws RepositoryException
RepositoryException
long[] getUserIds() throws RepositoryException
RepositoryException
org.outerx.daisy.x10.PublicUserInfoDocument getPublicUserInfo(long userId) throws RepositoryException
RepositoryException
org.outerx.daisy.x10.PublicUserInfosDocument getPublicUserInfos() throws RepositoryException
getUsers()
, this method can be called by any user.
RepositoryException
Roles getRoles() throws RepositoryException
RepositoryException
User createUser(java.lang.String login)
The persistency of this object towards the data store
is the responsibility of the client using the User
object itself by calling the User.save()
method.
login
- the user login used when authenticating
void deleteUser(long userId) throws RepositoryException
userId
- data store id of the User to delete
RepositoryException
User getUser(long userId, boolean updateable) throws RepositoryException
Only administrators can retrieve the User object for users that are not themselve.
userId
- the data store id of the desired User object
RepositoryException
Role getRole(long roleId, boolean updateable) throws RepositoryException
roleId
- the data store id of the desired Role object
RepositoryException
User getUser(java.lang.String userLogin, boolean updateable) throws RepositoryException
userLogin
- the login by which the desired User object is identified
RepositoryException
Role getRole(java.lang.String roleName, boolean updateable) throws RepositoryException
roleName
- the name by which the desired Role object is identified
RepositoryException
Role createRole(java.lang.String roleName)
roleName
-
void deleteRole(long roleId) throws RepositoryException
roleId
- data store id of the Role to delete
RepositoryException
java.lang.String getUserDisplayName(long userId) throws RepositoryException
This is the same as otherwise retrieved from User.getDisplayName()
.
UserNotFoundException
- if the user doesn't exist
RepositoryException
java.lang.String getUserLogin(long userId) throws RepositoryException
This is the same as otherwise retrieved from User.getLogin()
.
UserNotFoundException
- if the user doesn't exist
RepositoryException
long getUserId(java.lang.String login) throws RepositoryException
UserNotFoundException
- if the user doesn't exist
RepositoryException
java.lang.String getRoleDisplayName(long roleId) throws RepositoryException
This is the same as otherwise retrieved from Role.getName()
.
RoleNotFoundException
- if the role doesn't exist
RepositoryException
Users getUsersByEmail(java.lang.String email) throws RepositoryException
RepositoryException
AuthenticationSchemeInfos getAuthenticationSchemes() throws RepositoryException
RepositoryException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |