Blue Mind
Release 1.0

net.bluemind.core.api.services
Interface IUser

All Known Implementing Classes:
UserClient

public interface IUser


Method Summary
 java.lang.String changeMyPassword(AccessToken at, java.lang.String oldPass, java.lang.String newPass)
           
 java.lang.String changePassword(AccessToken at, java.lang.Integer id, java.lang.String oldPass, java.lang.String newPass)
           
 User create(AccessToken token, User user)
           
 User deleteUser(AccessToken token, int id)
           
 ResultList<User> find(AccessToken token, UserQuery uq)
           
 ResultList<User> findFromPatterns(AccessToken token, UserQuery uq)
          Used for users autocomplete
 java.util.List<Group> getAllMyGroups(AccessToken token, int id)
          Get user membership groups hierarchy list, excluding profile groups.
 java.util.Set<java.lang.String> getDomainUsersExtId(AccessToken at, int domainId)
          Get ext ID list of not archived domain users
 java.lang.String getEncryptPassword(AccessToken at, int id)
          Get encrypted password.
 java.util.List<Group> getGroups(AccessToken token, int id)
          Get user direct membership groups list
 java.util.List<Group> getMyGroups(AccessToken token, int id)
          Get user direct membership groups list excluding profile groups
 java.lang.String getUserExtIdFromLogin(AccessToken at, java.lang.String userLogin, int domainId)
          Get user ext ID from not archived user login and domain ID
 User getUserFromId(AccessToken token, int id)
           
 User update(AccessToken token, User user)
           
 User updateMyself(AccessToken token, User user)
           
 

Method Detail

getUserFromId

User getUserFromId(AccessToken token,
                   int id)
                   throws AuthFault,
                          ServerFault
Throws:
AuthFault
ServerFault

find

ResultList<User> find(AccessToken token,
                      UserQuery uq)
                      throws AuthFault,
                             ServerFault
Throws:
AuthFault
ServerFault

findFromPatterns

ResultList<User> findFromPatterns(AccessToken token,
                                  UserQuery uq)
                                  throws AuthFault,
                                         ServerFault
Used for users autocomplete

Parameters:
token -
uq -
Returns:
Throws:
AuthFault
ServerFault

create

User create(AccessToken token,
            User user)
            throws AuthFault,
                   ServerFault
Throws:
AuthFault
ServerFault

update

User update(AccessToken token,
            User user)
            throws AuthFault,
                   ServerFault
Throws:
AuthFault
ServerFault

updateMyself

User updateMyself(AccessToken token,
                  User user)
                  throws AuthFault,
                         ServerFault
Throws:
AuthFault
ServerFault

deleteUser

User deleteUser(AccessToken token,
                int id)
                throws AuthFault,
                       ServerFault
Throws:
AuthFault
ServerFault

getGroups

java.util.List<Group> getGroups(AccessToken token,
                                int id)
                                throws AuthFault,
                                       ServerFault
Get user direct membership groups list

Parameters:
token - bm-core token
id - user ID
Returns:
membership groups list
Throws:
AuthFault
ServerFault

changePassword

java.lang.String changePassword(AccessToken at,
                                java.lang.Integer id,
                                java.lang.String oldPass,
                                java.lang.String newPass)
                                throws AuthFault,
                                       ServerFault
Throws:
AuthFault
ServerFault

changeMyPassword

java.lang.String changeMyPassword(AccessToken at,
                                  java.lang.String oldPass,
                                  java.lang.String newPass)
                                  throws AuthFault,
                                         ServerFault
Throws:
AuthFault
ServerFault

getEncryptPassword

java.lang.String getEncryptPassword(AccessToken at,
                                    int id)
                                    throws AuthFault,
                                           ServerFault
Get encrypted password. Only global admin may do this.

Parameters:
at -
id -
Returns:
Throws:
AuthFault
ServerFault

getMyGroups

java.util.List<Group> getMyGroups(AccessToken token,
                                  int id)
                                  throws AuthFault,
                                         ServerFault
Get user direct membership groups list excluding profile groups

Parameters:
token - bm-core token
id - user ID
Returns:
membership groups list
Throws:
AuthFault
ServerFault

getAllMyGroups

java.util.List<Group> getAllMyGroups(AccessToken token,
                                     int id)
                                     throws AuthFault,
                                            ServerFault
Get user membership groups hierarchy list, excluding profile groups.

Parameters:
token - bm-core token
id - user ID
Returns:
membership groups list
Throws:
AuthFault
ServerFault

getDomainUsersExtId

java.util.Set<java.lang.String> getDomainUsersExtId(AccessToken at,
                                                    int domainId)
                                                    throws AuthFault,
                                                           ServerFault
Get ext ID list of not archived domain users

Parameters:
at - bm-core token
domainId - domain ID to get user ext ID list
Returns:
ext ID list of not archived domain users
Throws:
AuthFault
ServerFault

getUserExtIdFromLogin

java.lang.String getUserExtIdFromLogin(AccessToken at,
                                       java.lang.String userLogin,
                                       int domainId)
                                       throws AuthFault,
                                              ServerFault
Get user ext ID from not archived user login and domain ID

Parameters:
at - bm-core token
userLogin - user login
domainId - user domain ID
Returns:
  • user ext ID if exist and ext ID is set
  • empty string if user exist and ext ID not set
  • null if user doesn't exist
Throws:
AuthFault
ServerFault

Blue Mind
Release 1.0