com.atlassian.crowd.dao.token

Interface ExpirableUserTokenDao

All Known Implementing Classes:

ExpirableUserTokenDaoHibernate

public interface ExpirableUserTokenDao

DAO for ExpirableUserToken

Since:

v2.8

Method Summary

Modifier and Type	Method and Description
ExpirableUserToken	add(ExpirableUserToken token) Persist the given token
Optional<ExpirableUserToken>	findByToken(String token) Find the token with the given random hash
Optional<ExpirableUserToken>	findToken(long directoryId, String username) Returns token for given user.
boolean	removeByDirectoryAndUsername(long directoryId, String username) Remove all the tokens matching the username and directory id
boolean	removeByToken(String token) Removes the token with the given random hash
boolean	removeExpiredTokens(Date expiryDate) Remove all the tokens whose expiry date is older than the given cutoff date

Method Detail

findByToken

Optional<ExpirableUserToken> findByToken(String token)

Find the token with the given random hash

Parameters:

token - a random hash

Returns:

the token that was found, or none

add

ExpirableUserToken add(ExpirableUserToken token)
                throws ObjectAlreadyExistsException

Persist the given token

Parameters:

token - a token

Returns:

the persisted token

Throws:

ObjectAlreadyExistsException - if a token with the same random hash already exists

removeByToken

boolean removeByToken(String token)

Removes the token with the given random hash

Parameters:

token - a random hash

Returns:

true if a token was deleted, false otherwise

removeExpiredTokens

boolean removeExpiredTokens(Date expiryDate)

Remove all the tokens whose expiry date is older than the given cutoff date

Parameters:

expiryDate - a date

Returns:

true if some tokens were deleted, false otherwise

removeByDirectoryAndUsername

boolean removeByDirectoryAndUsername(long directoryId,
                                     String username)

Remove all the tokens matching the username and directory id

Parameters:

directoryId - directory where the user lives

username - username to remove tokens for

Returns:

true if some tokens were deleted, false otherwise

findToken

@ExperimentalApi
Optional<ExpirableUserToken> findToken(long directoryId,
                                                        String username)

Returns token for given user. For testing purposes only.