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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RemotePersonService.RemotePersonFinder
static interface	RemotePersonService.RemotePersonManyFetcher<T>	Deprecated. since 7.0.1.
static interface	RemotePersonService.RemotePersonSearcher
static interface	RemotePersonService.RemotePersonSingleFetcher	Deprecated. since 7.0.1.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	addMembership(String username, String groupName)	Add the given User identified by username to the given Group identified by groupName.
CompletionStage<Void>	changeMyPassword(PasswordChangeDetails passwordChangeDetails)	Change the password of the current user.
CompletionStage<Void>	changeUserPassword(String username, String newPass)	Change the password of the given user.
CompletionStage<UserKey>	create(UserDetailsForCreation userDetailsForCreation)	Create a new active user
LongTaskSubmission	delete(Person personToDelete)
CompletionStage<Void>	disable(String username)	Disable the given User identified by username.
CompletionStage<Void>	enable(String username)	Enable the given User identified by username.
RemotePersonService.RemotePersonFinder	find(Expansion... expansions)
default com.atlassian.util.concurrent.Promise<Person>	getCurrentUser(Expansion... expansions)	Deprecated. since 7.0.1.
CompletionStage<Person>	getCurrentUserCompletionStage(Expansion... expansions)
CompletionStage<Void>	removeMembership(String username, String groupName)	Remove the given User identified by username from the given Group identified by groupName.
RemotePersonService.RemotePersonSearcher	search()
PersonService.Validator	validator()	Get the validator of the Person Service.

Method Detail

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:

8.4.0

getCurrentUser

@Deprecated
default com.atlassian.util.concurrent.Promise<Person> getCurrentUser(Expansion... expansions)

Deprecated.

since 7.0.1. Use getCurrentUserCompletionStage(Expansion...) instead.

getCurrentUserCompletionStage

CompletionStage<Person> getCurrentUserCompletionStage(Expansion... expansions)

Since:

7.0.1

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:

8.2.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:

8.2.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:

8.2.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:

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:

8.4.0

changeMyPassword

CompletionStage<Void> changeMyPassword(PasswordChangeDetails passwordChangeDetails)

Change the password of the current user.

Parameters:

passwordChangeDetails - Password change details

Returns:

CompletionStage

Since:

8.4.0