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

Interface UserService

All Known Implementing Classes:

UserServiceImpl

public interface UserService

Method Summary

Modifier and Type	Method	Description
UserResponse	changePassword(String username, String current, String newPassword)	User changes password
UserResponse	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<UserResponse>	enableUsers(List<Long> userIds, List<String> usernames, boolean enabled)
void	forgotPassword(String username)	Forgot password feature for given username
List<UserResponse>	getAllUsers(String keyword, int offset, int limit, String sort)	Get paginated list of all users filtered by keyword
List<UserResponse>	getAllUsersForSite(long orgId, String site, String keyword, int offset, int limit, String sort)	Get paginated list of all users for site filtered by keyword
int	getAllUsersForSiteTotal(long orgId, String site, 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()
List<String>	getCurrentUserGlobalPermissions()	Get global permissions of the current authenticated user
List<String>	getCurrentUserSitePermissions(String site)	Get permissions of the current authenticated user for given site
List<String>	getCurrentUserSiteRoles(String site)
List<Site>	getCurrentUserSites()
String	getForgotPasswordToken(String username)	Get aforgot password token for given username
User	getUserByIdOrUsername(long userId, String username)
Map<String,Map<String,String>>	getUserProperties(String siteId)	Get the properties for the given site & the current user
List<NormalizedRole>	getUserSiteRoles(long userId, String username, String site)
List<Site>	getUserSites(long userId, String username)
Map<String,Boolean>	hasCurrentUserGlobalPermissions(List<String> permissions)	Check if the current authenticated user has given global permissions
Map<String,Boolean>	hasCurrentUserSitePermissions(String site, List<String> permissions)	Check if the current authenticated user has given permissions for given site
boolean	resetPassword(String username, String newPassword)	Admin resets the user password
UserResponse	setPassword(String token, String newPassword)	Set user password - forgot password token
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	validateToken(String token)	Validate forgot password token

Method Details

getAllUsersForSite

List<UserResponse> getAllUsersForSite(long orgId,
 String site,
 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

site - site identifier

keyword - keyword to filter users

offset - offset for pagination

limit - limit number of users to return per page

sort - sort order

Returns:

requested page of list of users

Throws:

ServiceLayerException

getAllUsers

List<UserResponse> 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 to return per page

sort - sort order

Returns:

requested page of list of users

Throws:

ServiceLayerException

getAllUsersForSiteTotal

int getAllUsersForSiteTotal(long orgId,
 String site,
 String keyword)
                     throws ServiceLayerException

Get total number of users for site filtered by keyword

Parameters:

orgId - organization identifier

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

UserResponse createUser(User user)
                 throws UserAlreadyExistsException,
ServiceLayerException,
AuthenticationException

Throws:

UserAlreadyExistsException

ServiceLayerException

AuthenticationException

updateUser

void updateUser(User user)
         throws ServiceLayerException,
UserNotFoundException,
AuthenticationException,
UserExternallyManagedException

Throws:

ServiceLayerException

UserNotFoundException

AuthenticationException

UserExternallyManagedException

deleteUsers

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

Throws:

ServiceLayerException

AuthenticationException

UserNotFoundException

UserExternallyManagedException

getUserByIdOrUsername

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

Throws:

ServiceLayerException

UserNotFoundException

enableUsers

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

Throws:

ServiceLayerException

UserNotFoundException

AuthenticationException

UserExternallyManagedException

getUserSites

List<Site> getUserSites(long userId,
 String username)
                 throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getUserSiteRoles

List<NormalizedRole> getUserSiteRoles(long userId,
 String username,
 String site)
                               throws ServiceLayerException,
UserNotFoundException

Throws:

ServiceLayerException

UserNotFoundException

getCurrentUser

AuthenticatedUser getCurrentUser()
                          throws AuthenticationException,
ServiceLayerException

Throws:

AuthenticationException

ServiceLayerException

getCurrentUserSites

List<Site> getCurrentUserSites()
                        throws AuthenticationException,
ServiceLayerException

Throws:

AuthenticationException

ServiceLayerException

getCurrentUserSiteRoles

List<String> getCurrentUserSiteRoles(String site)
                              throws AuthenticationException,
ServiceLayerException

Throws:

AuthenticationException

ServiceLayerException

forgotPassword

void forgotPassword(String username)
             throws ServiceLayerException

Forgot password feature for given username

Parameters:

username - user that forgot password

Throws:

ServiceLayerException - general service error

getForgotPasswordToken

String getForgotPasswordToken(String username)

Get aforgot password token for given username

Parameters:

username -

Returns:

changePassword

UserResponse changePassword(String username,
 String current,
 String newPassword)
                     throws PasswordDoesNotMatchException,
UserExternallyManagedException,
ServiceLayerException,
AuthenticationException,
UserNotFoundException

User changes password

Parameters:

username - username

current - current password

newPassword - new password

Returns:

user whose password is successfully changed

Throws:

PasswordDoesNotMatchException - password does not match with stored

UserExternallyManagedException - user is externally managed

ServiceLayerException - general service error

AuthenticationException - authentication error

UserNotFoundException - user not found

setPassword

UserResponse setPassword(String token,
 String newPassword)
                  throws UserNotFoundException,
UserExternallyManagedException,
ServiceLayerException

Set user password - forgot password token

Parameters:

token - forgot password token

newPassword - new password

Returns:

uses whose password is successfully set

Throws:

UserNotFoundException - user not found

UserExternallyManagedException - user is externally managed

ServiceLayerException - general service error

resetPassword

boolean resetPassword(String username,
 String newPassword)
               throws UserNotFoundException,
UserExternallyManagedException,
ServiceLayerException

Admin resets the user password

Parameters:

username - username

newPassword - new password

Returns:

true if user's password is successfully reset

Throws:

UserNotFoundException - user not found

UserExternallyManagedException - user is externally managed

ServiceLayerException - general service error

validateToken

boolean validateToken(String token)
               throws UserNotFoundException,
UserExternallyManagedException,
ServiceLayerException

Validate forgot password token

Parameters:

token - forgot password token to validate

Returns:

true if token is valid otherwise false

Throws:

UserNotFoundException - user not found

UserExternallyManagedException - user is externally managed

ServiceLayerException - general service error

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

getCurrentUserSitePermissions

List<String> getCurrentUserSitePermissions(String site)
                                    throws ServiceLayerException,
UserNotFoundException,
ExecutionException

Get permissions of the current authenticated user for given site

Parameters:

site - site identifier

Returns:

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

hasCurrentUserSitePermissions

Map<String,Boolean> hasCurrentUserSitePermissions(String site,
 List<String> permissions)
                                           throws ServiceLayerException,
UserNotFoundException,
ExecutionException

Check if the current authenticated user has given permissions for given site

Parameters:

site - site identifier

permissions - list of permissions to check

Returns:

map with values true or false for each given permission

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

getCurrentUserGlobalPermissions

List<String> getCurrentUserGlobalPermissions()
                                      throws ServiceLayerException,
UserNotFoundException,
ExecutionException

Get global permissions of the current authenticated user

Returns:

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

hasCurrentUserGlobalPermissions

Map<String,Boolean> hasCurrentUserGlobalPermissions(List<String> permissions)
                                             throws ServiceLayerException,
UserNotFoundException,
ExecutionException

Check if the current authenticated user has given global permissions

Parameters:

permissions - list of permissions to check

Returns:

map with values true or false for each given permission

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException