Package com.atlassian.crowd.service

Class TransactionalRememberMeService

java.lang.Object

com.atlassian.crowd.service.TransactionalRememberMeService

All Implemented Interfaces:

CrowdRememberMeService

@Transactional
public class TransactionalRememberMeService
extends Object
implements CrowdRememberMeService

Constructor Summary

Constructors

Constructor	Description
TransactionalRememberMeService(CrowdRememberMeTokenDAO tokenDAO, CrowdRememberMeConfiguration rememberMeConfiguration, com.atlassian.security.random.SecureTokenGenerator tokenGenerator, Clock clock, org.springframework.transaction.PlatformTransactionManager transactionManager)

Method Summary

Modifier and Type	Method	Description
Optional<org.springframework.security.core.Authentication>	authenticate(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Attempts to authenticate a request using the remember-me cookie provided on the request.
io.atlassian.fugue.Pair<InternalCrowdRememberMeToken,InternalCrowdRememberMeToken>	claimSingleUseToken(InternalCrowdRememberMeToken token)
void	clearAllExpiredTokens()	Clears all expired remember me tokens
void	clearAllTokens()	Clears all remember me tokens for all the users
void	clearAllTokensForDirectory(Long directoryId)	Clears all remember me tokens for the users belonging to the given directoryId
void	clearAllTokensForSeries(String series)	Clears all remember me tokens for the user with given series
void	clearAllTokensForUserInDirectory(String username, Long directoryId)	Clears all remember me tokens for the user with given username, and directory id
void	createCookie(User user, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Generates and saves a new remember-me token for the user.
protected InternalCrowdRememberMeToken	extractToken(jakarta.servlet.http.Cookie cookie)
CrowdSpecificRememberMeSettings	getConfiguration()	Retrieves current configuration
protected String	getRemoteAddress(jakarta.servlet.http.HttpServletRequest request)
LocalDateTime	now()
void	removeCookie(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Clears the remember-me cookie and removes all remember-me tokens for the corresponding series
void	saveConfiguration(CrowdSpecificRememberMeSettings configuration)	Validates and stores passed configuration, if CrowdSpecificRememberMeSettings.isEnabled() happens to be false all existing tokens will be expired immediately

Methods inherited from class java.lang.Object

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

Constructor Details

TransactionalRememberMeService

public TransactionalRememberMeService(CrowdRememberMeTokenDAO tokenDAO,
 CrowdRememberMeConfiguration rememberMeConfiguration,
 com.atlassian.security.random.SecureTokenGenerator tokenGenerator,
 Clock clock,
 org.springframework.transaction.PlatformTransactionManager transactionManager)

Method Details

authenticate

@Nullable
public Optional<org.springframework.security.core.Authentication> authenticate(@Nonnull
 jakarta.servlet.http.HttpServletRequest request,
 @Nonnull
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: CrowdRememberMeService

Attempts to authenticate a request using the remember-me cookie provided on the request. If authentication succeeds, a new remember-me token is created for the user and a new cookie is set on the response. If authentication fails for any reason, the cookie is cleared on the response.

Specified by:

authenticate in interface CrowdRememberMeService

Parameters:

request - the request

response - the response

Returns:

the authenticated user, or Optional.empty() if authentication failed.

createCookie

public void createCookie(@Nonnull
 User user,
 @Nonnull
 jakarta.servlet.http.HttpServletRequest request,
 @Nonnull
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: CrowdRememberMeService

Generates and saves a new remember-me token for the user. Sets the corresponding cookie on the response. If a remember-me cookie is already present in the response it will be overwritten.

Specified by:

createCookie in interface CrowdRememberMeService

Parameters:

user - the authenticating user

request - the request

response - the response

removeCookie

public void removeCookie(@Nonnull
 jakarta.servlet.http.HttpServletRequest request,
 @Nonnull
 jakarta.servlet.http.HttpServletResponse response)

Description copied from interface: CrowdRememberMeService

Clears the remember-me cookie and removes all remember-me tokens for the corresponding series

Specified by:

removeCookie in interface CrowdRememberMeService

Parameters:

request - the request

response - the response

clearAllTokensForSeries

public void clearAllTokensForSeries(String series)

Description copied from interface: CrowdRememberMeService

Clears all remember me tokens for the user with given series

Specified by:

clearAllTokensForSeries in interface CrowdRememberMeService

clearAllTokensForUserInDirectory

public void clearAllTokensForUserInDirectory(String username,
 Long directoryId)

Description copied from interface: CrowdRememberMeService

Clears all remember me tokens for the user with given username, and directory id

Specified by:

clearAllTokensForUserInDirectory in interface CrowdRememberMeService

clearAllTokens

public void clearAllTokens()

Description copied from interface: CrowdRememberMeService

Clears all remember me tokens for all the users

Specified by:

clearAllTokens in interface CrowdRememberMeService

clearAllExpiredTokens

public void clearAllExpiredTokens()

Description copied from interface: CrowdRememberMeService

Clears all expired remember me tokens

Specified by:

clearAllExpiredTokens in interface CrowdRememberMeService

clearAllTokensForDirectory

public void clearAllTokensForDirectory(Long directoryId)

Description copied from interface: CrowdRememberMeService

Clears all remember me tokens for the users belonging to the given directoryId

Specified by:

clearAllTokensForDirectory in interface CrowdRememberMeService

saveConfiguration

public void saveConfiguration(CrowdSpecificRememberMeSettings configuration)

Description copied from interface: CrowdRememberMeService

Validates and stores passed configuration, if CrowdSpecificRememberMeSettings.isEnabled() happens to be false all existing tokens will be expired immediately

Specified by:

saveConfiguration in interface CrowdRememberMeService

Parameters:

configuration - new configuration

getConfiguration

public CrowdSpecificRememberMeSettings getConfiguration()

Description copied from interface: CrowdRememberMeService

Retrieves current configuration

Specified by:

getConfiguration in interface CrowdRememberMeService

Returns:

configuration

extractToken

protected InternalCrowdRememberMeToken extractToken(jakarta.servlet.http.Cookie cookie)

claimSingleUseToken

public io.atlassian.fugue.Pair<InternalCrowdRememberMeToken,InternalCrowdRememberMeToken> claimSingleUseToken(InternalCrowdRememberMeToken token)

getRemoteAddress

protected String getRemoteAddress(jakarta.servlet.http.HttpServletRequest request)

now

public LocalDateTime now()