Package bucket.user

Interface UserAccessor

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      com.atlassian.user.Group addGroup​(String name)
      Deprecated.
      Creates a group with the specified name and returns it.
      void addMembership​(com.atlassian.user.Group group, com.atlassian.user.User user)
      Deprecated.
       
      void addMembership​(String groupname, String username)
      Deprecated.
       
      com.atlassian.user.User addUser​(String username, String password, String email, String fullname)
      Deprecated.
      since 3.5 use createUser(User, Credential)
      com.atlassian.user.User addUser​(String username, String password, String email, String fullname, String[] groups)
      Deprecated.
      since 3.5 use createUser(User, Credential) and addMembership(Group, User)
      void alterPassword​(com.atlassian.user.User user, String plainTextPassword)
      Deprecated.
       
      boolean authenticate​(String username, String password)
      Deprecated.
       
      com.atlassian.user.Group createGroup​(String groupname)
      Deprecated.
       
      com.atlassian.user.User createUser​(com.atlassian.user.User userTemplate, com.atlassian.user.security.password.Credential password)
      Deprecated.
       
      void deactivateUser​(com.atlassian.user.User user)
      Deprecated.
      Deactivate the specified user, which prevents them logging in.
      com.atlassian.user.search.SearchResult<com.atlassian.user.User> findUsers​(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
      Deprecated.
       
      com.atlassian.user.Group getGroup​(String name)
      Deprecated.
      Returns the group with the specified name, or null if the user doesn't exist or the name is null.
      com.atlassian.user.Group getGroupCreateIfNecessary​(String name)
      Deprecated.
       
      com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups()
      Deprecated.
      Returns a pager of all groups in the system.
      com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups​(com.atlassian.user.User user)
      Deprecated.
       
      com.atlassian.user.search.page.Pager<String> getMemberNames​(com.atlassian.user.Group group)
      Deprecated.
      Returns a pager containing the usernames of users who are members of the specified group (either directly or as a member of a nested group).
      com.opensymphony.module.propertyset.PropertySet getPropertySet​(com.atlassian.user.User user)
      Deprecated.
      since 7.7.
      com.atlassian.user.User getUser​(String name)
      Deprecated.
      Returns the user with the specified name, or null if the user doesn't exist or the name is null.
      com.atlassian.user.search.page.Pager<String> getUserNames()
      Deprecated.
      Returns a pager of all usernames in the system.
      com.atlassian.core.user.preferences.UserPreferences getUserPreferences​(com.atlassian.user.User user)
      Deprecated.
      since 7.7.
      com.atlassian.user.search.page.Pager<com.atlassian.user.User> getUsers()
      Deprecated.
      Returns a pager of all users in the system.
      com.atlassian.user.search.SearchResult getUsersByEmail​(String email)
      Deprecated.
       
      boolean hasMembership​(com.atlassian.user.Group group, com.atlassian.user.User user)
      Deprecated.
      Returns true if the specified user and group both exist, and the user is a member of the group (either directly or as a member of a nested group).
      boolean hasMembership​(String groupName, String username)
      Deprecated.
      Returns true if the specified user and group both exist, and the user is a member of the group (either directly or as a member of a nested group).
      boolean isDeactivated​(com.atlassian.user.User user)
      Deprecated.
      Returns true if the user exists and is unable to log in, otherwise false.
      boolean isDeactivated​(String username)
      Deprecated.
      Returns true if the user with the specified username exists and is unable to log in, otherwise false.
      boolean isLicensedToAddMoreUsers()
      Deprecated.
       
      boolean isUserRemovable​(com.atlassian.user.User user)
      Deprecated.
       
      void reactivateUser​(com.atlassian.user.User user)
      Deprecated.
      Marks the specified user as active, which allows them to log in.
      void removeGroup​(com.atlassian.user.Group group)
      Deprecated.
      Removes the specified group.
      boolean removeMembership​(com.atlassian.user.Group group, com.atlassian.user.User user)
      Deprecated.
       
      boolean removeMembership​(String groupname, String username)
      Deprecated.
       
      void removeUser​(com.atlassian.user.User user)
      Deprecated.
      Removes the specified user.
      void saveUser​(com.atlassian.user.User user)
      Deprecated.
      Persists changes made to a user (e.g.

      • Methods inherited from interface com.atlassian.user.search.query.EntityQueryParser

        findGroups, findGroups, findUsers

    • Method Detail

      • getUser

        com.atlassian.user.User getUser​(String name)
        Deprecated.
        Returns the user with the specified name, or null if the user doesn't exist or the name is null. Note that username lookups are case-insensitive, so the user you get back may not have exactly the same name as the name passed to this method.

      • getUserNames

        com.atlassian.user.search.page.Pager<String> getUserNames()
        Deprecated.
        Returns a pager of all usernames in the system. Clients should not normally use this method, but perform a search using findUsers(Query) or the CrowdService API instead.

      • getUsers

        com.atlassian.user.search.page.Pager<com.atlassian.user.User> getUsers()
        Deprecated.
        Returns a pager of all users in the system. Clients should not normally use this method, but perform a search using findUsers(Query) or the CrowdService API instead.

      • getGroup

        com.atlassian.user.Group getGroup​(String name)
        Deprecated.
        Returns the group with the specified name, or null if the user doesn't exist or the name is null.

      • getGroups

        com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups()
        Deprecated.
        Returns a pager of all groups in the system. Clients should not normally use this method, but perform a search using EntityQueryParser.findGroups(Query) or the CrowdService API instead.

      • addGroup

        com.atlassian.user.Group addGroup​(String name)
        Deprecated.
        Creates a group with the specified name and returns it.
        Throws:
        IllegalArgumentException - if the group name is empty or null
        com.atlassian.core.exception.InfrastructureException - if the group could not be created

      • removeGroup

        void removeGroup​(com.atlassian.user.Group group)
        Deprecated.
        Removes the specified group. Does nothing if the group does not exist.
        Throws:
        com.atlassian.core.exception.InfrastructureException - if the group could not be removed

      • removeUser

        void removeUser​(com.atlassian.user.User user)
         throws com.atlassian.core.exception.InfrastructureException
        Deprecated.
        Removes the specified user. Does nothing if the user does not exist.
        Throws:
        com.atlassian.core.exception.InfrastructureException - if the user could not be removed

      • getGroupCreateIfNecessary

        com.atlassian.user.Group getGroupCreateIfNecessary​(String name)
        Deprecated.

      • getUserPreferences

        @Deprecated
com.atlassian.core.user.preferences.UserPreferences getUserPreferences​(com.atlassian.user.User user)
        Deprecated.
        since 7.7. Plugins should use UserSettingsService

      • saveUser

        void saveUser​(com.atlassian.user.User user)
        Deprecated.
        Persists changes made to a user (e.g. changing email or full name).
        Throws:
        com.atlassian.core.exception.InfrastructureException - if the user could not be updated successfully

      • getUsersByEmail

        com.atlassian.user.search.SearchResult getUsersByEmail​(String email)
        Deprecated.

      • deactivateUser

        void deactivateUser​(com.atlassian.user.User user)
        Deprecated.
        Deactivate the specified user, which prevents them logging in. Does nothing if the user is already deactivated.

      • reactivateUser

        void reactivateUser​(com.atlassian.user.User user)
        Deprecated.
        Marks the specified user as active, which allows them to log in. Does nothing if the user is already active.

      • isLicensedToAddMoreUsers

        boolean isLicensedToAddMoreUsers()
        Deprecated.

      • isUserRemovable

        boolean isUserRemovable​(com.atlassian.user.User user)
                 throws com.atlassian.user.EntityException
        Deprecated.
        Throws:
        com.atlassian.user.EntityException

      • getGroups

        com.atlassian.user.search.page.Pager<com.atlassian.user.Group> getGroups​(com.atlassian.user.User user)
        Deprecated.

      • hasMembership

        boolean hasMembership​(com.atlassian.user.Group group,
                      com.atlassian.user.User user)
        Deprecated.
        Returns true if the specified user and group both exist, and the user is a member of the group (either directly or as a member of a nested group). In all other circumstances, returns false.

      • hasMembership

        boolean hasMembership​(String groupName,
                      String username)
        Deprecated.
        Returns true if the specified user and group both exist, and the user is a member of the group (either directly or as a member of a nested group). In all other circumstances, returns false.

      • addMembership

        void addMembership​(com.atlassian.user.Group group,
                   com.atlassian.user.User user)
        Deprecated.

      • addMembership

        void addMembership​(String groupname,
                   String username)
        Deprecated.

      • removeMembership

        boolean removeMembership​(com.atlassian.user.Group group,
                         com.atlassian.user.User user)
        Deprecated.

      • getPropertySet

        @Deprecated
com.opensymphony.module.propertyset.PropertySet getPropertySet​(com.atlassian.user.User user)
        Deprecated.
        since 7.7. Plugins should use UserSettingsService

      • getMemberNames

        com.atlassian.user.search.page.Pager<String> getMemberNames​(com.atlassian.user.Group group)
        Deprecated.
        Returns a pager containing the usernames of users who are members of the specified group (either directly or as a member of a nested group). Returns an empty pager if the group has no members or doesn't exist.

      • createUser

        com.atlassian.user.User createUser​(com.atlassian.user.User userTemplate,
                                   com.atlassian.user.security.password.Credential password)
        Deprecated.

      • createGroup

        com.atlassian.user.Group createGroup​(String groupname)
        Deprecated.

      • isDeactivated

        boolean isDeactivated​(com.atlassian.user.User user)
        Deprecated.
        Returns true if the user exists and is unable to log in, otherwise false. Returns false if the user is null.
        Returns:
        true if the user exists and is unable to log in, otherwise false.

      • isDeactivated

        boolean isDeactivated​(String username)
        Deprecated.
        Returns true if the user with the specified username exists and is unable to log in, otherwise false. Returns false if the username is null.
        Returns:
        true if the user with the specified username exists and is unable to log in, otherwise false.

      • authenticate

        boolean authenticate​(String username,
                     String password)
        Deprecated.

      • findUsers

        com.atlassian.user.search.SearchResult<com.atlassian.user.User> findUsers​(com.atlassian.user.search.query.Query<com.atlassian.user.User> search)
                                                                   throws com.atlassian.user.EntityException
        Deprecated.
        Specified by:
        findUsers in interface com.atlassian.user.search.query.EntityQueryParser
        Throws:
        com.atlassian.user.EntityException

      • alterPassword

        void alterPassword​(com.atlassian.user.User user,
                   String plainTextPassword)
            throws com.atlassian.user.EntityException
        Deprecated.
        Throws:
        com.atlassian.user.EntityException

      • removeMembership

        boolean removeMembership​(String groupname,
                         String username)
        Deprecated.