Package com.atlassian.confluence.rest.client

Class RemotePersonServiceImpl

java.lang.Object

com.atlassian.confluence.rest.client.AbstractRemoteService<PersonService>

com.atlassian.confluence.rest.client.RemotePersonServiceImpl

All Implemented Interfaces:

RemotePersonService

public class RemotePersonServiceImpl
extends AbstractRemoteService<PersonService>
implements RemotePersonService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	RemotePersonServiceImpl.RemotePersonFinderImpl

Nested classes/interfaces inherited from interface com.atlassian.confluence.rest.client.RemotePersonService

RemotePersonService.RemotePersonFinder, RemotePersonService.RemotePersonManyFetcher<T>, RemotePersonService.RemotePersonSearcher, RemotePersonService.RemotePersonSingleFetcher

Field Summary

Fields inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

provider

Constructor Summary

Constructors

Constructor	Description
RemotePersonServiceImpl(AuthenticatedWebResourceProvider provider, ExecutorService executor)

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.
CompletionStage<PageResponse<Person>>	fetchActiveUsers(PageRequest pageRequest)	Fetch active users.
RemotePersonService.RemotePersonFinder	find(Expansion... expansions)
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()
CompletionStage<Void>	update(UserDetailsForUpdate userDetailsForUpdate)	Update the current user with the supplied details (full name or email).
CompletionStage<Void>	update(String username, UserDetailsForUpdate userDetailsForUpdate)	Update the given user with the supplied details (full name or email).
PersonService.Validator	validator()	Get the validator of the Person Service.

Methods inherited from class com.atlassian.confluence.rest.client.AbstractRemoteService

addExpansions, addPageRequest, addPageRequestParams, deleteCompletionStage, deleteCompletionStage, getCompletionStage, getCompletionStageGenericCollection, getCompletionStageMap, getCompletionStageMapOfGenericListResponse, getCompletionStageMapOfPageResponses, getCompletionStageOptional, getCompletionStagePageResponseList, getCompletionStageSearchPageResponseList, getExecutor, newExperimentalRestWebTarget, newWebTarget, postCompletionStage, postCompletionStage, postCompletionStage, postCompletionStageToPageResponse, postVoidCompletionStage, putCompletionStage, putVoidCompletionStage

Methods inherited from class java.lang.Object

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

Constructor Details

RemotePersonServiceImpl

public RemotePersonServiceImpl(AuthenticatedWebResourceProvider provider,
 ExecutorService executor)

Since:

9.0

Method Details

create

public CompletionStage<UserKey> create(UserDetailsForCreation userDetailsForCreation)

Description copied from interface: RemotePersonService

Create a new active user

Specified by:

create in interface RemotePersonService

Parameters:

userDetailsForCreation - User Details

Returns:

com.atlassian.confluence.api.model.people.UserKey User Key

getCurrentUserCompletionStage

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

Specified by:

getCurrentUserCompletionStage in interface RemotePersonService

Since:

9.0

validator

public PersonService.Validator validator()

Description copied from interface: RemotePersonService

Get the validator of the Person Service.

Specified by:

validator in interface RemotePersonService

find

public RemotePersonService.RemotePersonFinder find(Expansion... expansions)

Specified by:

find in interface RemotePersonService

disable

public CompletionStage<Void> disable(String username)

Description copied from interface: RemotePersonService

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.

Specified by:

disable in interface RemotePersonService

Parameters:

username - The username identifying the given user.

enable

public CompletionStage<Void> enable(String username)

Description copied from interface: RemotePersonService

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.

Specified by:

enable in interface RemotePersonService

Parameters:

username - The username identifying the given user.

update

public CompletionStage<Void> update(UserDetailsForUpdate userDetailsForUpdate)

Description copied from interface: RemotePersonService

Update the current user with the supplied details (full name or email).

Specified by:

update in interface RemotePersonService

Parameters:

userDetailsForUpdate - User Details

update

public CompletionStage<Void> update(String username,
 UserDetailsForUpdate userDetailsForUpdate)

Description copied from interface: RemotePersonService

Update the given user with the supplied details (full name or email).

Specified by:

update in interface RemotePersonService

Parameters:

username - The username identifying the given user.

userDetailsForUpdate - User Details

delete

public LongTaskSubmission delete(Person personToDelete)

Specified by:

delete in interface RemotePersonService

search

public RemotePersonService.RemotePersonSearcher search()

Specified by:

search in interface RemotePersonService

addMembership

public CompletionStage<Void> addMembership(String username,
 String groupName)

Description copied from interface: RemotePersonService

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.

Specified by:

addMembership in interface RemotePersonService

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.

Returns:

CompletionStage

removeMembership

public CompletionStage<Void> removeMembership(String username,
 String groupName)

Description copied from interface: RemotePersonService

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.

Specified by:

removeMembership in interface RemotePersonService

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.

Returns:

CompletionStage

changeUserPassword

public CompletionStage<Void> changeUserPassword(String username,
 String newPass)

Description copied from interface: RemotePersonService

Change the password of the given user.

Specified by:

changeUserPassword in interface RemotePersonService

Parameters:

username - The username identifying the given user.

newPass - New password

Returns:

CompletionStage

changeMyPassword

public CompletionStage<Void> changeMyPassword(PasswordChangeDetails passwordChangeDetails)

Description copied from interface: RemotePersonService

Change the password of the current user.

Specified by:

changeMyPassword in interface RemotePersonService

Parameters:

passwordChangeDetails - Password change details

Returns:

CompletionStage

fetchActiveUsers

public CompletionStage<PageResponse<Person>> fetchActiveUsers(PageRequest pageRequest)

Description copied from interface: RemotePersonService

Fetch active users.

Specified by:

fetchActiveUsers in interface RemotePersonService

Returns:

CompletionStage of PageResponse of Person

Since:

9.3