Package org.craftercms.studio.api.v2.service.security.internal

Interface UserServiceInternal

All Known Implementing Classes:

UserServiceInternalImpl

public interface UserServiceInternal

Method Summary

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 user
void	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 keyword
List<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 keyword
int	getAllUsersForSiteTotal(long orgId, String siteId, String keyword)	Get total number of users for site filtered by keyword
int	getAllUsersTotal(String keyword)	Get total number of users filtered by keyword
AuthenticatedUser	getCurrentUser()	Returns the current authenticated user
User	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 user
List<User>	getUsersByIdOrUsername(List<Long> userIds, List<String> usernames)
boolean	isSystemAdmin(String username)	Check if given user has system_admin role
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 user
boolean	userExists(long userId, String username)

Method Details

getUserByIdOrUsername

@NonNull
User getUserByIdOrUsername(long userId,
 String username)
                    throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getUsersByIdOrUsername

List<User> getUsersByIdOrUsername(List<Long> userIds,
 List<String> usernames)
                           throws ServiceLayerException,
UserNotFoundException

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 identifier

groupNames - group names for site

keyword - keyword to filter users

offset - pagination offset

limit - limit number of users to return per page

sort - 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 users

offset - offset for pagination

limit - limit number of users per page

sort - 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 identifier

siteId - site identifier

keyword - 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

Throws:

UserAlreadyExistsException

ServiceLayerException

userExists

boolean userExists(long userId,
 String username)
            throws ServiceLayerException

Throws:

ServiceLayerException

updateUser

void updateUser(User user)
         throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

deleteUsers

void deleteUsers(List<Long> userIds,
 List<String> usernames)
          throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

enableUsers

List<User> enableUsers(List<Long> userIds,
 List<String> usernames,
 boolean enabled)
                throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

getUserGroups

List<Group> getUserGroups(long userId,
 String username)
                   throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

isUserMemberOfGroup

boolean isUserMemberOfGroup(String username,
 String groupName)
                     throws UserNotFoundException,
ServiceLayerException

Throws:

UserNotFoundException

ServiceLayerException

changePassword

boolean changePassword(String username,
 String current,
 String newPassword)
                throws PasswordDoesNotMatchException,
UserExternallyManagedException,
ServiceLayerException

Throws:

PasswordDoesNotMatchException

UserExternallyManagedException

ServiceLayerException

setUserPassword

boolean setUserPassword(String username,
 String newPassword)
                 throws UserNotFoundException,
ServiceLayerException

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 site

propertiesToUpdate - 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 site

propertiesToDelete - 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

isSystemAdmin

boolean isSystemAdmin(String username)

Check if given user has system_admin role

Parameters:

username - user

Returns:

true if user is system_admin, false otherwise