com.atlassian.crowd.dao.rememberme

Class CrowdRememberMeTokenDAOHibernate

java.lang.Object

com.atlassian.crowd.util.persistence.hibernate.StatelessDao

com.atlassian.crowd.util.persistence.hibernate.HibernateDao<InternalCrowdRememberMeToken>

com.atlassian.crowd.dao.rememberme.CrowdRememberMeTokenDAOHibernate

All Implemented Interfaces:

CrowdRememberMeTokenDAO

public class CrowdRememberMeTokenDAOHibernate
extends HibernateDao<InternalCrowdRememberMeToken>
implements CrowdRememberMeTokenDAO

Field Summary

Fields inherited from class com.atlassian.crowd.util.persistence.hibernate.HibernateDao

batchFinder, batchProcessor, logger, statelessSessionBatchProcessor, timeSource

Fields inherited from class com.atlassian.crowd.util.persistence.hibernate.StatelessDao

sessionFactory

Constructor Summary

Constructors

Constructor and Description
CrowdRememberMeTokenDAOHibernate()

Method Summary

Modifier and Type	Method and Description
Optional<InternalCrowdRememberMeToken>	findByIdExclusiveLock(Long id) Find token by the id, if present
Optional<InternalCrowdRememberMeToken>	findBySeriesAndToken(String series, String token)
List<InternalCrowdRememberMeToken>	findTokensForUser(String username, long directoryId) Lists tokens for the given username and the directory id
Class<InternalCrowdRememberMeToken>	getPersistentClass() All subclasses of HibernateDao must implement this method for HibernateDao.load(Serializable) to work correctly.
void	refresh(InternalCrowdRememberMeToken token) Reload the properties from database
void	removeAll() Removes all remember me tokens present
int	removeAllExpiredTokens(LocalDateTime lastValidTokenCreateTime, LocalDateTime lastValidUsedBeforeTime) Removes all tokens having createdTime before the lastValidTokenCreateTime, or usedTime before the lastValidUsedBeforeTime
int	removeTokensForDirectory(long directoryId) Removes all the tokens for the given directory
int	removeTokensForSeries(String series) Removes tokens for all the given series
int	removeTokensForUserInDirectory(String username, long directoryId) Removes all tokens for a user in the given directory
InternalCrowdRememberMeToken	save(InternalCrowdRememberMeToken token) Saves the token
boolean	setUsedByRemoteAddress(CrowdRememberMeToken crowdRememberMeToken) Tries to claim the given token if it is not yet claimed (used)

Methods inherited from class com.atlassian.crowd.util.persistence.hibernate.HibernateDao

createDeleteQuery, createDeleteQuery, createHibernateQuery, createQuery, createQuery, executeHQLQuery, findAllInternal, findByProperties, findByPropertiesOptional, findByProperty, findByProperty, findByPropertyOptional, findByPropertyOrThrow, load, load, loadOptional, loadReference, loadReference, remove, removeByIdIfPresent, save, saveOrUpdate, session, setBatchFinder, setBatchProcessor, setClock, setStatelessSessionBatchProcessor, toPredicates, update

Methods inherited from class com.atlassian.crowd.util.persistence.hibernate.StatelessDao

setSessionFactory, withStatelessSession

Methods inherited from class java.lang.Object

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

Constructor Detail

CrowdRememberMeTokenDAOHibernate

public CrowdRememberMeTokenDAOHibernate()

Method Detail

removeAll

public void removeAll()

Description copied from interface: CrowdRememberMeTokenDAO

Removes all remember me tokens present

Specified by:

removeAll in interface CrowdRememberMeTokenDAO

refresh

public void refresh(InternalCrowdRememberMeToken token)

Description copied from interface: CrowdRememberMeTokenDAO

Reload the properties from database

Specified by:

refresh in interface CrowdRememberMeTokenDAO

Parameters:

token - token to be refreshed

getPersistentClass

public Class<InternalCrowdRememberMeToken> getPersistentClass()

Description copied from class: HibernateDao

All subclasses of HibernateDao must implement this method for HibernateDao.load(Serializable) to work correctly.

Specified by:

getPersistentClass in class HibernateDao<InternalCrowdRememberMeToken>

Returns:

the entity class for this DAO

findByIdExclusiveLock

public Optional<InternalCrowdRememberMeToken> findByIdExclusiveLock(Long id)

Description copied from interface: CrowdRememberMeTokenDAO

Find token by the id, if present

Specified by:

findByIdExclusiveLock in interface CrowdRememberMeTokenDAO

findTokensForUser

public List<InternalCrowdRememberMeToken> findTokensForUser(String username,
                                                            long directoryId)

Description copied from interface: CrowdRememberMeTokenDAO

Lists tokens for the given username and the directory id

Specified by:

findTokensForUser in interface CrowdRememberMeTokenDAO

Parameters:

username - username of the user

directoryId - directory id to be searched for

Returns:

collection of tokens

save

public InternalCrowdRememberMeToken save(InternalCrowdRememberMeToken token)

Description copied from interface: CrowdRememberMeTokenDAO

Saves the token

Specified by:

save in interface CrowdRememberMeTokenDAO

removeAllExpiredTokens

public int removeAllExpiredTokens(LocalDateTime lastValidTokenCreateTime,
                                  LocalDateTime lastValidUsedBeforeTime)

Description copied from interface: CrowdRememberMeTokenDAO

Removes all tokens having createdTime before the lastValidTokenCreateTime, or usedTime before the lastValidUsedBeforeTime

Specified by:

removeAllExpiredTokens in interface CrowdRememberMeTokenDAO

Parameters:

lastValidTokenCreateTime - Last valid token create timestamp (exclusive)

lastValidUsedBeforeTime - Last valid token used timestamp (exclusive)

Returns:

number of tokens deleted

removeTokensForSeries

public int removeTokensForSeries(String series)

Description copied from interface: CrowdRememberMeTokenDAO

Removes tokens for all the given series

Specified by:

removeTokensForSeries in interface CrowdRememberMeTokenDAO

Parameters:

series - Series to remove all tokens for

Returns:

number of tokens deleted

findBySeriesAndToken

public Optional<InternalCrowdRememberMeToken> findBySeriesAndToken(@Nonnull
                                                                   String series,
                                                                   @Nonnull
                                                                   String token)

Specified by:

findBySeriesAndToken in interface CrowdRememberMeTokenDAO

Parameters:

series - Series to match token

token - token value to match

Returns:

a matching remember me token if exists

removeTokensForUserInDirectory

public int removeTokensForUserInDirectory(String username,
                                          long directoryId)

Description copied from interface: CrowdRememberMeTokenDAO

Removes all tokens for a user in the given directory

Specified by:

removeTokensForUserInDirectory in interface CrowdRememberMeTokenDAO

Parameters:

username - username of the user

directoryId - directory id to which the user belongs

Returns:

number of tokens deleted

removeTokensForDirectory

public int removeTokensForDirectory(long directoryId)

Description copied from interface: CrowdRememberMeTokenDAO

Removes all the tokens for the given directory

Specified by:

removeTokensForDirectory in interface CrowdRememberMeTokenDAO

Parameters:

directoryId - directory id to which the tokens belongs

Returns:

number of tokens deleted

setUsedByRemoteAddress

public boolean setUsedByRemoteAddress(CrowdRememberMeToken crowdRememberMeToken)

Description copied from interface: CrowdRememberMeTokenDAO

Tries to claim the given token if it is not yet claimed (used)

Specified by:

setUsedByRemoteAddress in interface CrowdRememberMeTokenDAO

Parameters:

crowdRememberMeToken - token to be claimed

Returns:

whether attempt was successful or not