Package com.atlassian.confluence.api.impl.service.people

Class ReadOnlyPersonService

java.lang.Object

com.atlassian.confluence.api.impl.service.people.ReadOnlyPersonService

All Implemented Interfaces:

PersonService

public class ReadOnlyPersonService
extends Object
implements PersonService

For use in the Velocity context.

Since:

8.8

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.api.service.people.PersonService

PersonService.PersonFinder, PersonService.PersonSearcher, PersonService.SinglePersonFetcher, PersonService.Validator

Constructor Summary

Constructors

Constructor	Description
ReadOnlyPersonService(PersonService delegate)

Method Summary

Modifier and Type	Method	Description
void	addMembership(String username, String groupName)	Add the given User identified by username to the given Group identified by groupName.
void	changeMyPassword(PasswordChangeDetails passwordChangeDetails)	Change the password of the current user.
void	changeUserPassword(String userName, String newPass)	Change the password of the given user.
UserKey	create(UserDetailsForCreation userDetailsForCreation)	Create a new active user
LongTaskSubmission	delete(Person personToDelete)	Delete the given person.
void	disable(String username)	Disable the given User identified by username.
void	enable(String username)	Enable the given User identified by username.
PersonService.PersonFinder	find(Expansion... expansions)	Create a person finder to locate persons Restrictions can be applied to the finder using the appropriate withFoo() method
Person	getCurrentUser(Expansion... expansions)	Get the currently logged in user
void	removeMembership(String username, String groupName)	Remove the given User identified by username from the given Group identified by groupName.
PersonService.PersonSearcher	search()	Create a person searcher to find people matching search criteria For given search category and/or criteria, return all People matching the supplied criteria.
PersonService.Validator	validator()	Get the validator of the Person Service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyPersonService

public ReadOnlyPersonService(PersonService delegate)

Method Detail

create

public UserKey create(UserDetailsForCreation userDetailsForCreation)

Description copied from interface: PersonService

Create a new active user

Specified by:

create in interface PersonService

Parameters:

userDetailsForCreation - User Details

Returns:

UserKey User Key

getCurrentUser

public Person getCurrentUser(Expansion... expansions)

Description copied from interface: PersonService

Get the currently logged in user

Specified by:

getCurrentUser in interface PersonService

find

public PersonService.PersonFinder find(Expansion... expansions)

Description copied from interface: PersonService

Create a person finder to locate persons Restrictions can be applied to the finder using the appropriate withFoo() method

For example:

 personService.find()
      .withKey("DEV")
      .fetchOne()
 
 

Specified by:

find in interface PersonService

Returns:

a new PersonFinder

disable

public void disable(String username)

Description copied from interface: PersonService

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 PersonService

Parameters:

username - The username identifying the given user.

enable

public void enable(String username)

Description copied from interface: PersonService

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 PersonService

Parameters:

username - The username identifying the given user.

delete

public LongTaskSubmission delete(Person personToDelete)

Description copied from interface: PersonService

Delete the given person.

The deletion happens asynchronously so a LongTaskSubmission is returned, that can be used to track progress.

Specified by:

delete in interface PersonService

Parameters:

personToDelete - the person to delete

Returns:

a LongTaskSubmission describing the user deletion operation

search

public PersonService.PersonSearcher search()

Description copied from interface: PersonService

Create a person searcher to find people matching search criteria For given search category and/or criteria, return all People matching the supplied criteria.

For example:

 personService.search()
      .forUnsyncedUsers("joe")
      .fetchMany(..)
 
 

Specified by:

search in interface PersonService

Returns:

a new PersonSearcher

addMembership

public void addMembership(String username,
                          String groupName)

Description copied from interface: PersonService

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 PersonService

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.

removeMembership

public void removeMembership(String username,
                             String groupName)

Description copied from interface: PersonService

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 PersonService

Parameters:

username - The username identifying the given user.

groupName - The group name identifying the given group.

changeUserPassword

public void changeUserPassword(String userName,
                               String newPass)

Description copied from interface: PersonService

Change the password of the given user.

Specified by:

changeUserPassword in interface PersonService

Parameters:

userName - The userName identifying the given user.

newPass - New Password

changeMyPassword

public void changeMyPassword(PasswordChangeDetails passwordChangeDetails)

Description copied from interface: PersonService

Change the password of the current user.

Specified by:

changeMyPassword in interface PersonService

Parameters:

passwordChangeDetails - password change details

validator

public PersonService.Validator validator()

Description copied from interface: PersonService

Get the validator of the Person Service.

Specified by:

validator in interface PersonService