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

Class UserServiceImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.security.UserServiceImpl

All Implemented Interfaces:

UserService

public class UserServiceImpl
extends Object
implements UserService

Constructor Summary

Constructors

Constructor	Description
UserServiceImpl()

Method Summary

Modifier and Type	Method	Description
UserResponse	changePassword(String username, String current, String newPassword)	User changes password
UserResponse	createUser(User user)
protected String	decryptToken(String hashedToken)
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 siteId, 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()
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<String>	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
void	setAccessTokenServiceInternal(AccessTokenServiceInternal accessTokenServiceInternal)
void	setAuditServiceInternal(AuditServiceInternal auditServiceInternal)
void	setConfigurationService(ConfigurationService configurationService)
void	setEncryptor(org.craftercms.commons.crypto.TextEncryptor encryptor)
void	setEntitlementValidator(org.craftercms.commons.entitlements.validator.EntitlementValidator entitlementValidator)
void	setForgotPasswordTaskFactory(org.springframework.beans.factory.ObjectFactory<ForgotPasswordTaskFactory> forgotPasswordTaskFactory)
void	setGeneralLockService(GeneralLockService generalLockService)
void	setGroupServiceInternal(GroupServiceInternal groupServiceInternal)
void	setInstanceService(InstanceService instanceService)
UserResponse	setPassword(String token, String newPassword)	Set user password - forgot password token
void	setSecurityService(SecurityService securityService)
void	setSecurityServiceV2(SecurityService securityServiceV2)
void	setSessionRegistry(org.springframework.security.core.session.SessionRegistry sessionRegistry)
void	setSiteService(SiteService siteService)
void	setStudioConfiguration(StudioConfiguration studioConfiguration)
void	setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
void	setUserServiceInternal(UserServiceInternal userServiceInternal)
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
protected boolean	validateDecryptedToken(String decryptedToken)
boolean	validateToken(String token)	Validate forgot password token

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserServiceImpl

public UserServiceImpl()

Method Details

getAllUsersForSite

public List<UserResponse> getAllUsersForSite(long orgId,
 String siteId,
 String keyword,
 int offset,
 int limit,
 String sort)
                                      throws ServiceLayerException

Description copied from interface: UserService

Get paginated list of all users for site filtered by keyword

Specified by:

getAllUsersForSite in interface UserService

Parameters:

orgId - organization identifier

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

public List<UserResponse> getAllUsers(String keyword,
 int offset,
 int limit,
 String sort)
                               throws ServiceLayerException

Description copied from interface: UserService

Get paginated list of all users filtered by keyword

Specified by:

getAllUsers in interface UserService

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

public int getAllUsersForSiteTotal(long orgId,
 String siteId,
 String keyword)
                            throws ServiceLayerException

Description copied from interface: UserService

Get total number of users for site filtered by keyword

Specified by:

getAllUsersForSiteTotal in interface UserService

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

public int getAllUsersTotal(String keyword)
                     throws ServiceLayerException

Description copied from interface: UserService

Get total number of users filtered by keyword

Specified by:

getAllUsersTotal in interface UserService

Parameters:

keyword - keyword to filter user

Returns:

total number of users filtered by keyword

Throws:

ServiceLayerException

createUser

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

Specified by:

createUser in interface UserService

Throws:

UserAlreadyExistsException

ServiceLayerException

AuthenticationException

updateUser

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

Specified by:

updateUser in interface UserService

Throws:

ServiceLayerException

UserNotFoundException

AuthenticationException

UserExternallyManagedException

deleteUsers

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

Specified by:

deleteUsers in interface UserService

Throws:

ServiceLayerException

AuthenticationException

UserNotFoundException

UserExternallyManagedException

getUserByIdOrUsername

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

Specified by:

getUserByIdOrUsername in interface UserService

Throws:

ServiceLayerException

UserNotFoundException

enableUsers

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

Specified by:

enableUsers in interface UserService

Throws:

ServiceLayerException

UserNotFoundException

AuthenticationException

UserExternallyManagedException

getUserSites

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

Specified by:

getUserSites in interface UserService

Throws:

ServiceLayerException

UserNotFoundException

getUserSiteRoles

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

Specified by:

getUserSiteRoles in interface UserService

Throws:

ServiceLayerException

UserNotFoundException

getCurrentUser

public AuthenticatedUser getCurrentUser()
                                 throws AuthenticationException

Specified by:

getCurrentUser in interface UserService

Throws:

AuthenticationException

getCurrentUserSites

public List<Site> getCurrentUserSites()
                               throws AuthenticationException,
ServiceLayerException

Specified by:

getCurrentUserSites in interface UserService

Throws:

AuthenticationException

ServiceLayerException

getCurrentUserSiteRoles

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

Specified by:

getCurrentUserSiteRoles in interface UserService

Throws:

AuthenticationException

ServiceLayerException

forgotPassword

public void forgotPassword(String username)

Description copied from interface: UserService

Forgot password feature for given username

Specified by:

forgotPassword in interface UserService

Parameters:

username - user that forgot password

getForgotPasswordToken

public String getForgotPasswordToken(String username)

Description copied from interface: UserService

Get aforgot password token for given username

Specified by:

getForgotPasswordToken in interface UserService

Parameters:

username -

Returns:

decryptToken

protected String decryptToken(String hashedToken)

changePassword

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

Description copied from interface: UserService

User changes password

Specified by:

changePassword in interface UserService

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

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

Description copied from interface: UserService

Set user password - forgot password token

Specified by:

setPassword in interface UserService

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

validateToken

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

Description copied from interface: UserService

Validate forgot password token

Specified by:

validateToken in interface UserService

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

validateDecryptedToken

protected boolean validateDecryptedToken(String decryptedToken)
                                  throws UserNotFoundException,
ServiceLayerException,
UserExternallyManagedException

Throws:

UserNotFoundException

ServiceLayerException

UserExternallyManagedException

resetPassword

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

Description copied from interface: UserService

Admin resets the user password

Specified by:

resetPassword in interface UserService

Parameters:

username - username

newPassword - new password

Returns:

true if user's password is successfully reset

Throws:

UserNotFoundException - user not found

ServiceLayerException - general service error

getUserProperties

public Map<String,Map<String,String>> getUserProperties(String siteId)
                                                 throws ServiceLayerException

Description copied from interface: UserService

Get the properties for the given site & the current user

Specified by:

getUserProperties in interface UserService

Parameters:

siteId - the id of the site

Returns:

the current properties

Throws:

ServiceLayerException - if there is any error fetching the properties

updateUserProperties

public Map<String,String> updateUserProperties(String siteId,
 Map<String,String> propertiesToUpdate)
                                        throws ServiceLayerException

Description copied from interface: UserService

Update or add properties for the given site & the current user

Specified by:

updateUserProperties in interface UserService

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

public Map<String,String> deleteUserProperties(String siteId,
 List<String> propertiesToDelete)
                                        throws ServiceLayerException

Description copied from interface: UserService

Delete properties for the given site & current user

Specified by:

deleteUserProperties in interface UserService

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

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

Description copied from interface: UserService

Get permissions of the current authenticated user for given site

Specified by:

getCurrentUserSitePermissions in interface UserService

Parameters:

site - site identifier

Returns:

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

hasCurrentUserSitePermissions

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

Description copied from interface: UserService

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

Specified by:

hasCurrentUserSitePermissions in interface UserService

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

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

Description copied from interface: UserService

Get global permissions of the current authenticated user

Specified by:

getCurrentUserGlobalPermissions in interface UserService

Returns:

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

hasCurrentUserGlobalPermissions

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

Description copied from interface: UserService

Check if the current authenticated user has given global permissions

Specified by:

hasCurrentUserGlobalPermissions in interface UserService

Parameters:

permissions - list of permissions to check

Returns:

map with values true or false for each given permission

Throws:

ServiceLayerException

UserNotFoundException

ExecutionException

setUserServiceInternal

public void setUserServiceInternal(UserServiceInternal userServiceInternal)

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

setGroupServiceInternal

public void setGroupServiceInternal(GroupServiceInternal groupServiceInternal)

setSiteService

public void setSiteService(SiteService siteService)

setEntitlementValidator

public void setEntitlementValidator(org.craftercms.commons.entitlements.validator.EntitlementValidator entitlementValidator)

setGeneralLockService

public void setGeneralLockService(GeneralLockService generalLockService)

setSecurityService

public void setSecurityService(SecurityService securityService)

setStudioConfiguration

public void setStudioConfiguration(StudioConfiguration studioConfiguration)

setAuditServiceInternal

public void setAuditServiceInternal(AuditServiceInternal auditServiceInternal)

setAccessTokenServiceInternal

public void setAccessTokenServiceInternal(AccessTokenServiceInternal accessTokenServiceInternal)

setInstanceService

public void setInstanceService(InstanceService instanceService)

setEncryptor

public void setEncryptor(org.craftercms.commons.crypto.TextEncryptor encryptor)

setSecurityServiceV2

public void setSecurityServiceV2(SecurityService securityServiceV2)

setSessionRegistry

public void setSessionRegistry(org.springframework.security.core.session.SessionRegistry sessionRegistry)

setTaskExecutor

public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)

setForgotPasswordTaskFactory

public void setForgotPasswordTaskFactory(org.springframework.beans.factory.ObjectFactory<ForgotPasswordTaskFactory> forgotPasswordTaskFactory)