Package com.atlassian.confluence.rest.client

Interface RemotePersonService

All Known Implementing Classes:
RemotePersonServiceImpl
public interface RemotePersonService
PersonService implementation that communicates with Confluence remotely using the Confluence REST API.

Provides promise returning equivalents for the methods in PersonService.

  • Method Details

    • create

      CompletionStage<UserKey> create(UserDetailsForCreation userDetailsForCreation)
      Create a new active user
      Parameters:
      userDetailsForCreation - User Details
      Returns:
      com.atlassian.confluence.api.model.people.UserKey User Key
      Since:
      9.0 8.4.0

    • getCurrentUserCompletionStage

      CompletionStage<Person> getCurrentUserCompletionStage(Expansion... expansions)
      Since:
      9.0

    • validator

      PersonService.Validator validator()
      Get the validator of the Person Service.

    • find

      RemotePersonService.RemotePersonFinder find(Expansion... expansions)

    • disable

      CompletionStage<Void> disable(String username)
      Disable the given User identified by username. This method is idempotent i.e. if the user is already disabled then no action will be taken.
      Parameters:
      username - The username identifying the given user.
      Since:
      9.0

    • enable

      CompletionStage<Void> enable(String username)
      Enable the given User identified by username. This method is idempotent i.e. if the user is already enabled then no action will be taken.
      Parameters:
      username - The username identifying the given user.
      Since:
      9.0

    • update

      CompletionStage<Void> update(UserDetailsForUpdate userDetailsForUpdate)
      Update the current user with the supplied details (full name or email).
      Parameters:
      userDetailsForUpdate - User Details
      Since:
      9.3.0

    • update

      CompletionStage<Void> update(String username, UserDetailsForUpdate userDetailsForUpdate)
      Update the given user with the supplied details (full name or email).
      Parameters:
      username - The username identifying the given user.
      userDetailsForUpdate - User Details
      Since:
      9.3.0

    • delete

      LongTaskSubmission delete(Person personToDelete)

    • search

      RemotePersonService.RemotePersonSearcher search()

    • addMembership

      CompletionStage<Void> addMembership(String username, String groupName)
      Add the given User identified by username to the given Group identified by groupName. This method is idempotent i.e. if the membership already exists then no action will be taken.
      Parameters:
      username - The username identifying the given user.
      groupName - The group name identifying the given group.
      Returns:
      CompletionStage
      Since:
      9.0

    • removeMembership

      CompletionStage<Void> removeMembership(String username, String groupName)
      Remove the given User identified by username from the given Group identified by groupName. This method is idempotent i.e. if the membership is not present then no action will be taken.
      Parameters:
      username - The username identifying the given user.
      groupName - The group name identifying the given group.
      Returns:
      CompletionStage
      Since:
      9.0 8.2.0

    • changeUserPassword

      CompletionStage<Void> changeUserPassword(String username, String newPass)
      Change the password of the given user.
      Parameters:
      username - The username identifying the given user.
      newPass - New password
      Returns:
      CompletionStage
      Since:
      9.0

    • changeMyPassword

      CompletionStage<Void> changeMyPassword(PasswordChangeDetails passwordChangeDetails)
      Change the password of the current user.
      Parameters:
      passwordChangeDetails - Password change details
      Returns:
      CompletionStage
      Since:
      9.0

    • fetchActiveUsers

      CompletionStage<PageResponse<Person>> fetchActiveUsers(PageRequest pageRequest)
      Fetch active users.
      Returns:
      CompletionStage of PageResponse of Person
      Since:
      9.3