com.atlassian.jira.user.util

Interface UserKeyStore

All Known Implementing Classes:

MockUserKeyStore, UserKeyStoreImpl

@Internal
public interface UserKeyStore

Since:

v6.0

Method Summary

Modifier and Type	Method and Description
String	ensureUniqueKeyForNewUser(String username)
Long	getIdForUserKey(String name)
String	getKeyForUsername(String username)
Optional<ApplicationUserEntity>	getUserForId(Long id)
Optional<ApplicationUserEntity>	getUserForKey(String key)
Optional<ApplicationUserEntity>	getUserForUsername(String username)
String	getUsernameForKey(String key)
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)

Method Detail

getUsernameForKey

String getUsernameForKey(String key)

getKeyForUsername

String getKeyForUsername(String username)

renameUser

@Internal
void renameUser(String oldUsername,
                          String newUsername)

ensureUniqueKeyForNewUser

@Internal
String ensureUniqueKeyForNewUser(String username)

getIdForUserKey

@Internal
Long getIdForUserKey(String name)

getUserForId

@Internal
Optional<ApplicationUserEntity> getUserForId(Long id)

getUserForKey

@Internal
Optional<ApplicationUserEntity> getUserForKey(String key)

getUserForUsername

@Internal
Optional<ApplicationUserEntity> getUserForUsername(String username)

removeByKey

@Internal
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. 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).

Parameters:

key - the key to remove.

Returns:

the name of the user deleted.