com.atlassian.confluence.user.persistence.dao

Interface ConfluenceUserDao

All Known Implementing Classes:

CachingConfluenceUserDao, HibernateConfluenceUserDao

@ParametersAreNonnullByDefault
public interface ConfluenceUserDao

A DAO for manipulating ConfluenceUser objects (which essentially act as a mapping between a user key and a User object retrieved externally e.g. from Embedded Crowd).

Since:

5.2

Method Summary

Modifier and Type	Method and Description
void	create(ConfluenceUser user) Create a new ConfluenceUser.
ConfluenceUser	findByKey(com.atlassian.sal.api.user.UserKey key) Retrieve a ConfluenceUser by the user key.
Map<com.atlassian.sal.api.user.UserKey,Optional<ConfluenceUser>>	findByKeys(Set<com.atlassian.sal.api.user.UserKey> userkeys) Performs a bulk lookup of multiple ConfluenceUsers.
ConfluenceUser	findByUsername(String username) Find the ConfluenceUser with the given user name.
Map<com.atlassian.sal.api.user.UserKey,String>	findLowerNamesByKeys(Iterable<com.atlassian.sal.api.user.UserKey> keys) Bulk operation to find lowercase name corresponding to user key.
Map<String,com.atlassian.sal.api.user.UserKey>	findUserKeysByLowerNames(Iterable<String> names) Bulk operation to find user key corresponding to lowercase name.
Set<ConfluenceUser>	getAll()
List<com.atlassian.sal.api.user.UserKey>	getAllUserKeys() Currently for testing purpose only
void	remove(ConfluenceUser user) Remove the supplied ConfluenceUser from persistence.
ConfluenceUser	rename(String oldUsername, String newUsername, boolean overrideExisting) Renames a user
void	update(ConfluenceUser user) Change a property of an existing ConfluenceUser.

Method Detail

create

void create(ConfluenceUser user)

Create a new ConfluenceUser.

Parameters:

user -

update

void update(ConfluenceUser user)

Change a property of an existing ConfluenceUser.

Parameters:

user -

remove

void remove(ConfluenceUser user)

Remove the supplied ConfluenceUser from persistence.

Parameters:

user -

rename

@Nonnull
ConfluenceUser rename(String oldUsername,
                               String newUsername,
                               boolean overrideExisting)

Renames a user

Parameters:

oldUsername - old username for the user

newUsername - new username for the user

overrideExisting - True if possible existing mapping should make way for the renamed one. False for opposite behaviour.

Returns:

renamed user

findByKey

@Nullable
ConfluenceUser findByKey(@Nullable
                                   com.atlassian.sal.api.user.UserKey key)

Retrieve a ConfluenceUser by the user key.

Parameters:

key -

Returns:

a ConfluenceUser with the supplied key

findByUsername

@Nullable
ConfluenceUser findByUsername(@Nullable
                                        String username)

Find the ConfluenceUser with the given user name.

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.

Parameters:

username -

Returns:

a ConfluenceUser with the supplied username.

getAll

@Nonnull
Set<ConfluenceUser> getAll()

Returns:

all the ConfluenceUser

Since:

5.3

findUserKeysByLowerNames

Map<String,com.atlassian.sal.api.user.UserKey> findUserKeysByLowerNames(Iterable<String> names)

Bulk operation to find user key corresponding to lowercase name.

Parameters:

names -

Returns:

map of lowercase name by user key

findLowerNamesByKeys

Map<com.atlassian.sal.api.user.UserKey,String> findLowerNamesByKeys(Iterable<com.atlassian.sal.api.user.UserKey> keys)

Bulk operation to find lowercase name corresponding to user key.

Parameters:

keys -

Returns:

map of user key by lowercase name

findByKeys

Map<com.atlassian.sal.api.user.UserKey,Optional<ConfluenceUser>> findByKeys(Set<com.atlassian.sal.api.user.UserKey> userkeys)

Performs a bulk lookup of multiple ConfluenceUsers.

Parameters:

userkeys - The set of UserKeys

Returns:

A Map of UserKeys to Optional ConfluenceUsers. Every UserKey present in the userkeys parameter will have an entry in this map.

Since:

6.12.0

getAllUserKeys

List<com.atlassian.sal.api.user.UserKey> getAllUserKeys()

Currently for testing purpose only

Returns:

all user keys

Since:

6.12.0