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

Class UserServiceInternalImpl

java.lang.Object

org.craftercms.studio.impl.v2.service.security.internal.UserServiceInternalImpl

All Implemented Interfaces:

UserServiceInternal, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class UserServiceInternalImpl
extends Object
implements UserServiceInternal, org.springframework.context.ApplicationContextAware

Constructor Summary

Constructors

Constructor	Description
UserServiceInternalImpl(UserDAO userDao, GroupServiceInternal groupServiceInternal, StudioConfiguration studioConfiguration, SiteService siteService, SecurityService securityService, RetryingDatabaseOperationFacade retryingDatabaseOperationFacade, com.google.common.cache.Cache<String,User> userCache, com.nulabinc.zxcvbn.Zxcvbn zxcvbn)

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)
protected String	getActualSiteId(String siteId)
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<NormalizedGroup> 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
protected String	getGlobalSiteName()
User	getUserByGitName(String gitName)	Get user by git name.
User	getUserByIdOrUsername(long userId, String username)
List<Group>	getUserGroups(long userId, String username)	Retrieves the list of groups associated with the specified user.
List<Group>	getUserGroups(long userId, String username, boolean filterExternallyManagedGroups)	Retrieves the list of groups associated with the specified user, optionally filtering to include only externally managed groups.
Map<String,Map<String,String>>	getUserProperties(String siteId)	Get the properties for the given site & the current user
protected Map<String,String>	getUserProperties(User user, long siteId)
List<User>	getUsersByIdOrUsername(List<Long> userIds, List<String> usernames)
protected void	invalidateCache(String username)
protected void	invalidateCache(Collection<User> users)
protected void	invalidateCache(List<String> usernames)
boolean	isSystemAdmin(String username)	Check if given user has system_admin role
boolean	isUserMemberOfGroup(String username, String groupName)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
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)

Methods inherited from class java.lang.Object

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

Constructor Details

UserServiceInternalImpl

@ConstructorProperties({"userDao","groupServiceInternal","studioConfiguration","siteService","securityService","retryingDatabaseOperationFacade","userCache","zxcvbn"})
public UserServiceInternalImpl(UserDAO userDao,
 GroupServiceInternal groupServiceInternal,
 StudioConfiguration studioConfiguration,
 SiteService siteService,
 SecurityService securityService,
 RetryingDatabaseOperationFacade retryingDatabaseOperationFacade,
 com.google.common.cache.Cache<String,User> userCache,
 com.nulabinc.zxcvbn.Zxcvbn zxcvbn)

Method Details

invalidateCache

protected void invalidateCache(String username)

invalidateCache

protected void invalidateCache(List<String> usernames)

invalidateCache

protected void invalidateCache(Collection<User> users)

getUserByIdOrUsername

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

Specified by:

getUserByIdOrUsername in interface UserServiceInternal

Throws:

ServiceLayerException

UserNotFoundException

getUsersByIdOrUsername

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

Specified by:

getUsersByIdOrUsername in interface UserServiceInternal

Throws:

ServiceLayerException

UserNotFoundException

getAllUsersForSite

public List<User> getAllUsersForSite(long orgId,
 List<NormalizedGroup> groupNames,
 String keyword,
 int offset,
 int limit,
 String sort)
                              throws ServiceLayerException

Description copied from interface: UserServiceInternal

Get paginated list of all users for site filtered by keyword

Specified by:

getAllUsersForSite in interface UserServiceInternal

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

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

Description copied from interface: UserServiceInternal

Get paginated list of all users filtered by keyword

Specified by:

getAllUsers in interface UserServiceInternal

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

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

Description copied from interface: UserServiceInternal

Get total number of users for site filtered by keyword

Specified by:

getAllUsersForSiteTotal in interface UserServiceInternal

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: UserServiceInternal

Get total number of users filtered by keyword

Specified by:

getAllUsersTotal in interface UserServiceInternal

Parameters:

keyword - keyword to filter user

Returns:

total number of users filtered by keyword

Throws:

ServiceLayerException

createUser

public User createUser(User user)
                throws UserAlreadyExistsException,
ServiceLayerException

Specified by:

createUser in interface UserServiceInternal

Throws:

UserAlreadyExistsException

ServiceLayerException

userExists

public boolean userExists(long userId,
 String username)
                   throws ServiceLayerException

Specified by:

userExists in interface UserServiceInternal

Throws:

ServiceLayerException

updateUser

public void updateUser(User user)
                throws UserNotFoundException,
ServiceLayerException

Specified by:

updateUser in interface UserServiceInternal

Throws:

UserNotFoundException

ServiceLayerException

deleteUsers

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

Specified by:

deleteUsers in interface UserServiceInternal

Throws:

UserNotFoundException

ServiceLayerException

enableUsers

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

Specified by:

enableUsers in interface UserServiceInternal

Throws:

ServiceLayerException

UserNotFoundException

getUserGroups

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

Description copied from interface: UserServiceInternal

Retrieves the list of groups associated with the specified user.

Specified by:

getUserGroups in interface UserServiceInternal

Parameters:

userId - the unique identifier of the user

username - the username of the user

Returns:

a list of Group objects associated with the user

Throws:

UserNotFoundException - if no user is found with the given userId or username

ServiceLayerException - if an error occurs while accessing the service layer

getUserGroups

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

Description copied from interface: UserServiceInternal

Retrieves the list of groups associated with the specified user, optionally filtering to include only externally managed groups.

Specified by:

getUserGroups in interface UserServiceInternal

Parameters:

userId - the unique identifier of the user

username - the username of the user

filterExternallyManagedGroups - if true, only externally managed groups are returned; if false, all groups are returned

Returns:

a list of Group objects associated with the user, filtered based on the flag

Throws:

UserNotFoundException - if no user is found with the given userId or username

ServiceLayerException - if an error occurs while accessing the service layer

isUserMemberOfGroup

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

Specified by:

isUserMemberOfGroup in interface UserServiceInternal

Throws:

UserNotFoundException

ServiceLayerException

changePassword

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

Specified by:

changePassword in interface UserServiceInternal

Throws:

PasswordDoesNotMatchException

UserExternallyManagedException

ServiceLayerException

setUserPassword

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

Specified by:

setUserPassword in interface UserServiceInternal

Throws:

UserNotFoundException

ServiceLayerException

getUserByGitName

public User getUserByGitName(String gitName)
                      throws ServiceLayerException,
UserNotFoundException

Description copied from interface: UserServiceInternal

Get user by git name. Special use case because git stores user as string of first and last name separated by ' '

Specified by:

getUserByGitName in interface UserServiceInternal

Parameters:

gitName - first and last name separated with ' '

Returns:

user

Throws:

ServiceLayerException

UserNotFoundException

getUserProperties

protected Map<String,String> getUserProperties(User user,
 long siteId)

getGlobalSiteName

protected String getGlobalSiteName()

getActualSiteId

protected String getActualSiteId(String siteId)

getUserProperties

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

Description copied from interface: UserServiceInternal

Get the properties for the given site & the current user

Specified by:

getUserProperties in interface UserServiceInternal

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: UserServiceInternal

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

Specified by:

updateUserProperties in interface UserServiceInternal

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: UserServiceInternal

Delete properties for the given site & current user

Specified by:

deleteUserProperties in interface UserServiceInternal

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

public AuthenticatedUser getCurrentUser()
                                 throws AuthenticationException

Description copied from interface: UserServiceInternal

Returns the current authenticated user

Specified by:

getCurrentUser in interface UserServiceInternal

Returns:

the user if present

Throws:

AuthenticationException - if there is no user authenticated

isSystemAdmin

public boolean isSystemAdmin(String username)

Description copied from interface: UserServiceInternal

Check if given user has system_admin role

Specified by:

isSystemAdmin in interface UserServiceInternal

Parameters:

username - user

Returns:

true if user is system_admin, false otherwise

setApplicationContext

public void setApplicationContext(@NonNull
 org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException