com.atlassian.jira.user.util

Class UserKeyStoreImpl

java.lang.Object

com.atlassian.jira.user.util.UserKeyStoreImpl

All Implemented Interfaces:

UserKeyStore

public class UserKeyStoreImpl
extends Object
implements UserKeyStore

Constructor Summary

Constructors

Constructor and Description
UserKeyStoreImpl(EntityEngine entityEngine, OfBizDelegator ofBizDelegator, org.ofbiz.core.entity.DelegatorInterface delegatorInterface, com.atlassian.event.api.EventPublisher eventPublisher, com.atlassian.cache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
void	changeKey(String oldUserKey, String newUserKey)
String	ensureUniqueKeyForNewUser(String username)
Long	getIdForUserKey(String userKey)
String	getKeyForUsername(String username)
String	getKeyFromId(long id) Returns key generated from id.
Optional<String>	getUniqueKeyFromId(long id) Returns unique key generated from id.
Optional<String>	getUniqueUsernameFromId(long id) Returns unique username generated from id.
protected int	getUniqueValueRetryCount()
Optional<ApplicationUserEntity>	getUserForId(Long id)
Optional<ApplicationUserEntity>	getUserForKey(String key)
Optional<ApplicationUserEntity>	getUserForUsername(String username)
String	getUsernameForKey(String userKey)
boolean	isSystemKey(String key) Returns true if passed key has been generated automatically by Jira.
void	onClearCache(ClearCacheEvent event)
String	removeByKey(String key) It is dangerous to use this method. In general operation Jira needs to keep the userName -> key mapping around even if the user is deleted.
void	renameUser(String oldUsername, String newUsername)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserKeyStoreImpl

public UserKeyStoreImpl(EntityEngine entityEngine,
                        OfBizDelegator ofBizDelegator,
                        org.ofbiz.core.entity.DelegatorInterface delegatorInterface,
                        com.atlassian.event.api.EventPublisher eventPublisher,
                        com.atlassian.cache.CacheManager cacheManager)

Method Detail

getUsernameForKey

public String getUsernameForKey(String userKey)

Specified by:

getUsernameForKey in interface UserKeyStore

getKeyForUsername

public String getKeyForUsername(String username)

Specified by:

getKeyForUsername in interface UserKeyStore

getIdForUserKey

public Long getIdForUserKey(String userKey)

Specified by:

getIdForUserKey in interface UserKeyStore

getUserForId

public Optional<ApplicationUserEntity> getUserForId(Long id)

Specified by:

getUserForId in interface UserKeyStore

getUserForKey

public Optional<ApplicationUserEntity> getUserForKey(String key)

Specified by:

getUserForKey in interface UserKeyStore

getUserForUsername

public Optional<ApplicationUserEntity> getUserForUsername(String username)

Specified by:

getUserForUsername in interface UserKeyStore

renameUser

public void renameUser(String oldUsername,
                       String newUsername)

Specified by:

renameUser in interface UserKeyStore

ensureUniqueKeyForNewUser

public String ensureUniqueKeyForNewUser(String username)

Specified by:

ensureUniqueKeyForNewUser in interface UserKeyStore

removeByKey

public String removeByKey(String key)

Description copied from interface: UserKeyStore

It is dangerous to use this method. In general operation Jira needs to keep the userName -> key mapping around even if the user is deleted. This is so that it can show something in the UI after the user is deleted.

This method is used by cloud for import where all the users are deleted anyways (see JiraUserServiceImpl).

Specified by:

removeByKey in interface UserKeyStore

Parameters:

key - the key to remove.

Returns:

the name of the user deleted.

isSystemKey

public boolean isSystemKey(@Nonnull
                           String key)

Description copied from interface: UserKeyStore

Returns true if passed key has been generated automatically by Jira.

Specified by:

isSystemKey in interface UserKeyStore

Returns:

true if passed key has been generated automatically by Jira, false otherwise.

getKeyFromId

@Nonnull
public String getKeyFromId(long id)

Description copied from interface: UserKeyStore

Returns key generated from id.

Specified by:

getKeyFromId in interface UserKeyStore

Returns:

key generated from id.

getUniqueKeyFromId

@Nonnull
public Optional<String> getUniqueKeyFromId(long id)

Description copied from interface: UserKeyStore

Returns unique key generated from id.

Specified by:

getUniqueKeyFromId in interface UserKeyStore

Returns:

unique key generated from id.

getUniqueUsernameFromId

@Nonnull
public Optional<String> getUniqueUsernameFromId(long id)

Description copied from interface: UserKeyStore

Returns unique username generated from id.

Specified by:

getUniqueUsernameFromId in interface UserKeyStore

Returns:

unique username generated from id.

changeKey

public void changeKey(@Nonnull
                      String oldUserKey,
                      @Nonnull
                      String newUserKey)

Specified by:

changeKey in interface UserKeyStore

onClearCache

@EventListener
public void onClearCache(ClearCacheEvent event)

getUniqueValueRetryCount

protected int getUniqueValueRetryCount()