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
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.cache.CacheFactory cacheFactory)

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.
ConfluenceUser	findByUsername(String username) Find the ConfluenceUser with the given user 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.cache.CacheFactory cacheFactory)

Method Detail

create

public void create(ConfluenceUser user)

Description copied from interface: ConfluenceUserDao

Create a new ConfluenceUser.

Specified by:

create in interface ConfluenceUserDao

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

public ConfluenceUser findByKey(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

public ConfluenceUser findByUsername(@Nullable
                                     String username)

Description copied from interface: ConfluenceUserDao

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.

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