com.atlassian.confluence.impl.user.persistence.dao

Class CachingConfluenceUserDao

java.lang.Object

com.atlassian.confluence.impl.user.persistence.dao.CachingConfluenceUserDao

All Implemented Interfaces:

ConfluenceUserDao

@ParametersAreNonnullByDefault
 @ReturnValuesAreNonnullByDefault
public class CachingConfluenceUserDao
extends Object
implements ConfluenceUserDao

This class is responsible for caching user keys by username.

Since:

5.8

Constructor Summary

Constructors

Constructor and Description
CachingConfluenceUserDao(ConfluenceUserDao delegate, com.atlassian.vcache.VCacheFactory cacheFactory)

Method Summary

Modifier and Type	Method and Description
void	create(ConfluenceUser user) Create a new ConfluenceUser.
boolean	createIfMissing(ConfluenceUser user) Create a new ConfluenceUser or do nothing if it exists already.
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.
Map<String,ConfluenceUser>	findByLowerNames(Iterable<String> usernames) Bulk operation to find ConfluenceUser corresponding to lowercase name.
ConfluenceUser	findByUsername(String username) Attempts to find a ConfluenceUser for the given username.
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()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingConfluenceUserDao

public CachingConfluenceUserDao(ConfluenceUserDao delegate,
                                com.atlassian.vcache.VCacheFactory cacheFactory)

Method Detail

create

public void create(ConfluenceUser user)

Description copied from interface: ConfluenceUserDao

Create a new ConfluenceUser.

Specified by:

create in interface ConfluenceUserDao

createIfMissing

public boolean createIfMissing(ConfluenceUser user)

Description copied from interface: ConfluenceUserDao

Create a new ConfluenceUser or do nothing if it exists already.

Specified by:

createIfMissing in interface ConfluenceUserDao

Returns:

true if the user was created

update

public void update(ConfluenceUser user)

Description copied from interface: ConfluenceUserDao

Change a property of an existing ConfluenceUser.

Specified by:

update in interface ConfluenceUserDao

remove

public void remove(ConfluenceUser user)

Description copied from interface: ConfluenceUserDao

Remove the supplied ConfluenceUser from persistence.

Specified by:

remove in interface ConfluenceUserDao

rename

public ConfluenceUser rename(String oldUsername,
                             String newUsername,
                             boolean overrideExisting)

Description copied from interface: ConfluenceUserDao

Renames a user

Specified by:

rename in interface ConfluenceUserDao

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
public ConfluenceUser findByKey(@Nullable
                                          com.atlassian.sal.api.user.UserKey key)

Description copied from interface: ConfluenceUserDao

Retrieve a ConfluenceUser by the user key.

Specified by:

findByKey in interface ConfluenceUserDao

Returns:

a ConfluenceUser with the supplied key

findByUsername

@Nullable
public ConfluenceUser findByUsername(@Nullable
                                               String username)

Attempts to find a ConfluenceUser for the given username.

If the userkey for the given username is not cached, then the delegate DAO will be invoked to find the user for the username, and that user's key will then be added to the cache. Future lookups for that username will use the cached userkey and then find the user for that key (via the delegate DAO). This is the "normal" use-case.

If the delegate initially returns no user for the username, then the cache will be populated with an empty value (this is a requirement of the VCache API which requires value loaders to return *something*, even if it's just an Optional.empty). However, since new users can be added via other DAOs (e.g. during crowd sync), and this class isn't aware of such activity, then subsequent lookups for that username need to ignore this "empty" cached userkey and instead re-invoke the delegate DAO to re-lookup the user. This is a bit weird, but is necessary to work around this "back door" addition of users.

Specified by:

findByUsername in interface ConfluenceUserDao

Returns:

a ConfluenceUser with the supplied username.

getAll

public Set<ConfluenceUser> getAll()

Specified by:

getAll in interface ConfluenceUserDao

Returns:

all the ConfluenceUser

findUserKeysByLowerNames

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

Description copied from interface: ConfluenceUserDao

Bulk operation to find user key corresponding to lowercase name.

Specified by:

findUserKeysByLowerNames in interface ConfluenceUserDao

Returns:

map of lowercase name by user key

findByLowerNames

public Map<String,ConfluenceUser> findByLowerNames(Iterable<String> usernames)

Description copied from interface: ConfluenceUserDao

Bulk operation to find ConfluenceUser corresponding to lowercase name.

Specified by:

findByLowerNames in interface ConfluenceUserDao

Parameters:

usernames - lowercase user names

Returns:

map of lowercase name by ConfluenceUser

findLowerNamesByKeys

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

Description copied from interface: ConfluenceUserDao

Bulk operation to find lowercase name corresponding to user key.

Specified by:

findLowerNamesByKeys in interface ConfluenceUserDao

Returns:

map of user key by lowercase name

findByKeys

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

Description copied from interface: ConfluenceUserDao

Performs a bulk lookup of multiple ConfluenceUsers.

Specified by:

findByKeys in interface ConfluenceUserDao

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.