Package org.craftercms.studio.api.v2.dal

Interface UserDAO

public interface UserDAO

  • Method Details

    • getAllUsersForSite

      List<User> getAllUsersForSite(@Param("groupNames") List<String> groupNames, @Param("keyword") String keyword, @Param("offset") int offset, @Param("limit") int limit, @Param("sort") String sort)
      Get all users for given site
      Parameters:
      groupNames - group names
      keyword - keyword to filter users
      offset - offset for pagination
      limit - limit number of users per page
      sort - sort order;
      Returns:
      List of users

    • getAllUsers

      List<User> getAllUsers(@Param("keyword") String keyword, @Param("offset") int offset, @Param("limit") int limit, @Param("sort") String sort)
      Get all users
      Parameters:
      keyword - keyword to filter users
      offset - offset for pagination
      limit - limit number of users per page
      sort - sort order;
      Returns:
      List of users

    • createUser

      int createUser(Map params)
      Create user
      Parameters:
      params - SQL query parameters
      Returns:
      Number of rows affected in DB

    • updateUser

      int updateUser(Map params)
      Update user
      Parameters:
      params - SQL query parameters
      Returns:
      Number of rows affected in DB

    • getUserIdsForUsernames

      List<Long> getUserIdsForUsernames(Map params)
      Get ids for users
      Parameters:
      params - SQL query parameters
      Returns:
      List of user ids

    • deleteUsers

      int deleteUsers(Map params)
      Delete users
      Parameters:
      params - SQL query params
      Returns:
      Number of rows affected in DB

    • getUserByIdOrUsername

      User getUserByIdOrUsername(Map params)
      Get user by id or username
      Parameters:
      params - SQL query parameters
      Returns:
      User or null if not found

    • enableUsers

      int enableUsers(Map params)
      Enable/disable users
      Parameters:
      params - SQL query parameters
      Returns:
      Number of rows affected in DB

    • getUserGroups

      List<Group> getUserGroups(Map params)
      Get user groups
      Parameters:
      params - SQL query parameters
      Returns:
      List of groups

    • getAllUsersForSiteTotal

      int getAllUsersForSiteTotal(@Param("groupNames") List<String> groupNames, @Param("keyword") String keyword)
      Get total number of users
      Parameters:
      groupNames - group names
      keyword - keyword to filter users
      Returns:
      total number of users for site

    • getAllUsersTotal

      int getAllUsersTotal(@Param("keyword") String keyword)
      Get total number of users
      Parameters:
      keyword - keyword to filter users
      Returns:
      total number of all users

    • setUserPassword

      int setUserPassword(Map params)
      Set password for user
      Parameters:
      params - SQL query parameters
      Returns:
      Number of rows affected

    • userExists

      Integer userExists(Map params)
      Check if user exists
      Parameters:
      params - SQL query params
      Returns:
      positive number if user exists, otherwise 0

    • isUserMemberOfGroup

      Integer isUserMemberOfGroup(Map params)
      Check if user is member of given group
      Parameters:
      params - SQL query parameters
      Returns:
      if true result greater than 0

    • getUserByGitName

      User getUserByGitName(@Param("gitName") String gitName)
      Get user by git name
      Parameters:
      gitName - SQL query parameter
      Returns:
      User or null if not found

    • getUserProperties

      List<UserProperty> getUserProperties(@Param("userId") long userId, @Param("siteId") long siteId)
      Returns the current user properties
      Parameters:
      userId - the id of the user
      siteId - the id of the site
      Returns:
      the properties

    • deleteUserProperties

      void deleteUserProperties(@Param("userId") long userId, @Param("siteId") long siteId, @Param("keys") List<String> keys)
      Deletes the given user properties
      Parameters:
      userId - the id of the user
      siteId - the id of the site
      keys - the keys to delete

    • updateUserProperties

      void updateUserProperties(@Param("userId") long userId, @Param("siteId") long siteId, @Param("properties") Map<String,String> properties)
      Updates the given user properties
      Parameters:
      userId - the id of the user
      siteId - the id of the site
      properties - the properties to update or add

    • deleteUserPropertiesBySiteId

      void deleteUserPropertiesBySiteId(@Param("siteId") long siteId)
      Deletes all user properties for a given site
      Parameters:
      siteId - the id of the site

    • deleteUserPropertiesByUserIds

      void deleteUserPropertiesByUserIds(@Param("userIds") List<Long> userIds)
      Deletes all user properties for a given user
      Parameters:
      userIds - the id of the user