Interface UserServiceInternal
-
- All Known Implementing Classes:
UserServiceInternalImpl
public interface UserServiceInternal
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
changePassword(String username, String current, String newPassword)
User
createUser(User user)
Map<String,String>
deleteUserProperties(String siteId, List<String> propertiesToDelete)
Delete properties for the given site & current uservoid
deleteUsers(List<Long> userIds, List<String> usernames)
List<User>
enableUsers(List<Long> userIds, List<String> usernames, boolean enabled)
List<User>
getAllUsers(String keyword, int offset, int limit, String sort)
Get paginated list of all users filtered by keywordList<User>
getAllUsersForSite(long orgId, List<String> groupNames, String keyword, int offset, int limit, String sort)
Get paginated list of all users for site filtered by keywordint
getAllUsersForSiteTotal(long orgId, String siteId, String keyword)
Get total number of users for site filtered by keywordint
getAllUsersTotal(String keyword)
Get total number of users filtered by keywordAuthenticatedUser
getCurrentUser()
Returns the current authenticated userUser
getUserByGitName(String gitName)
Get user by git name.User
getUserByIdOrUsername(long userId, String username)
List<Group>
getUserGroups(long userId, String username)
Map<String,Map<String,String>>
getUserProperties(String siteId)
Get the properties for the given site & the current userList<User>
getUsersByIdOrUsername(List<Long> userIds, List<String> usernames)
boolean
isUserMemberOfGroup(String username, String groupName)
boolean
setUserPassword(String username, String newPassword)
void
updateUser(User user)
Map<String,String>
updateUserProperties(String siteId, Map<String,String> propertiesToUpdate)
Update or add properties for the given site & the current userboolean
userExists(long userId, String username)
-
-
-
Method Detail
-
getUserByIdOrUsername
@NonNull User getUserByIdOrUsername(long userId, String username) throws UserNotFoundException, ServiceLayerException
-
getUsersByIdOrUsername
List<User> getUsersByIdOrUsername(List<Long> userIds, List<String> usernames) throws ServiceLayerException, UserNotFoundException
-
getAllUsersForSite
List<User> getAllUsersForSite(long orgId, List<String> groupNames, String keyword, int offset, int limit, String sort) throws ServiceLayerException
Get paginated list of all users for site filtered by keyword- Parameters:
orgId
- organization identifiergroupNames
- group names for sitekeyword
- keyword to filter usersoffset
- pagination offsetlimit
- limit number of users to return per pagesort
- sort order- Returns:
- requested page of list of users
- Throws:
ServiceLayerException
-
getAllUsers
List<User> getAllUsers(String keyword, int offset, int limit, String sort) throws ServiceLayerException
Get paginated list of all users filtered by keyword- Parameters:
keyword
- keyword to filter usersoffset
- offset for paginationlimit
- limit number of users per pagesort
- sort order- Returns:
- requested page of list of users
- Throws:
ServiceLayerException
-
getAllUsersForSiteTotal
int getAllUsersForSiteTotal(long orgId, String siteId, String keyword) throws ServiceLayerException
Get total number of users for site filtered by keyword- Parameters:
orgId
- organization identifiersiteId
- site identifierkeyword
- keyword to filter users- Returns:
- total number of users for site filtered by keyword
- Throws:
ServiceLayerException
-
getAllUsersTotal
int getAllUsersTotal(String keyword) throws ServiceLayerException
Get total number of users filtered by keyword- Parameters:
keyword
- keyword to filter user- Returns:
- total number of users filtered by keyword
- Throws:
ServiceLayerException
-
createUser
User createUser(User user) throws UserAlreadyExistsException, ServiceLayerException
-
userExists
boolean userExists(long userId, String username) throws ServiceLayerException
- Throws:
ServiceLayerException
-
updateUser
void updateUser(User user) throws UserNotFoundException, ServiceLayerException
-
deleteUsers
void deleteUsers(List<Long> userIds, List<String> usernames) throws UserNotFoundException, ServiceLayerException
-
enableUsers
List<User> enableUsers(List<Long> userIds, List<String> usernames, boolean enabled) throws UserNotFoundException, ServiceLayerException
-
getUserGroups
List<Group> getUserGroups(long userId, String username) throws UserNotFoundException, ServiceLayerException
-
isUserMemberOfGroup
boolean isUserMemberOfGroup(String username, String groupName) throws UserNotFoundException, ServiceLayerException
-
changePassword
boolean changePassword(String username, String current, String newPassword) throws PasswordDoesNotMatchException, UserExternallyManagedException, ServiceLayerException
-
setUserPassword
boolean setUserPassword(String username, String newPassword) throws UserNotFoundException, ServiceLayerException
-
getUserByGitName
User getUserByGitName(String gitName) throws ServiceLayerException, UserNotFoundException
Get user by git name. Special use case because git stores user as string of first and last name separated by ' '- Parameters:
gitName
- first and last name separated with ' '- Returns:
- user
- Throws:
ServiceLayerException
UserNotFoundException
-
getUserProperties
Map<String,Map<String,String>> getUserProperties(String siteId) throws ServiceLayerException
Get the properties for the given site & the current user- Parameters:
siteId
- the id of the site- Returns:
- the current properties
- Throws:
ServiceLayerException
- if there is any error fetching the properties
-
updateUserProperties
Map<String,String> updateUserProperties(String siteId, Map<String,String> propertiesToUpdate) throws ServiceLayerException
Update or add properties for the given site & the current user- Parameters:
siteId
- the id of the sitepropertiesToUpdate
- the properties to update or add- Returns:
- the updated properties
- Throws:
ServiceLayerException
- if there is any error updating or fetching the properties
-
deleteUserProperties
Map<String,String> deleteUserProperties(String siteId, List<String> propertiesToDelete) throws ServiceLayerException
Delete properties for the given site & current user- Parameters:
siteId
- the id of the sitepropertiesToDelete
- the list of keys to delete- Returns:
- the updated properties
- Throws:
ServiceLayerException
- if there is any error deleting or fetching the properties
-
getCurrentUser
AuthenticatedUser getCurrentUser() throws AuthenticationException
Returns the current authenticated user- Returns:
- the user if present
- Throws:
AuthenticationException
- if there is no user authenticated
-
-