Class JdbcTokenRepository

java.lang.Object

com.codename1.backend.security.rememberme.JdbcTokenRepository

All Implemented Interfaces:

PersistentTokenRepository

public final class JdbcTokenRepository
extends Object
implements PersistentTokenRepository

Remembered sign-ins kept in the server's database, in the cn1_persistent_logins table of SecuritySchema, so that any process of a deployment recognizes a cookie any other issued.

http.rememberMe(remember -> remember.tokenRepository(new JdbcTokenRepository(dataSource)));

A token is replaced by one UPDATE that names the hash it expects to find, and counted as replaced only when that changed exactly one row.

Constructor Summary

Constructors

Constructor	Description
JdbcTokenRepository(DataSource dataSource)

Method Summary

Modifier and Type	Method	Description
void	createNewToken(PersistentRememberMeToken token)	Stores a new series.
int	deleteExpired(long now, long olderThanSeconds)	Deletes the series last used more than olderThanSeconds ago: for a scheduled job, since a cookie nobody presents again leaves its row behind.
PersistentRememberMeToken	getTokenForSeries(String series)	The stored token of series, or null.
void	removeToken(String series)	Forgets one series: one browser.
void	removeUserTokens(String username)	Forgets every series of a user: every browser they were remembered in.
boolean	updateToken(String series, String expectedTokenHash, String newTokenHash, long lastUsed)	Replaces the token of series, if it is still expectedTokenHash.

Methods inherited from class Object

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

Constructor Details

JdbcTokenRepository

public JdbcTokenRepository(DataSource dataSource)

Method Details

createNewToken

public void createNewToken(PersistentRememberMeToken token)

Description copied from interface: PersistentTokenRepository

Stores a new series.

Specified by:

createNewToken in interface PersistentTokenRepository

updateToken

public boolean updateToken(String series,
 String expectedTokenHash,
 String newTokenHash,
 long lastUsed)

Description copied from interface: PersistentTokenRepository

Replaces the token of series, if it is still expectedTokenHash.

The test and the change are one step: of two requests presenting the same cookie at the same moment, one replaces the token and the other is told it did not. Store expectedTokenHash as the previous hash of the replacement token, so concurrent requests can recognize the rotation for a bounded grace period.

Specified by:

updateToken in interface PersistentTokenRepository

Returns:

whether this call replaced it

getTokenForSeries

public PersistentRememberMeToken getTokenForSeries(String series)

Description copied from interface: PersistentTokenRepository

The stored token of series, or null.

Specified by:

getTokenForSeries in interface PersistentTokenRepository

removeToken

public void removeToken(String series)

Description copied from interface: PersistentTokenRepository

Forgets one series: one browser.

Specified by:

removeToken in interface PersistentTokenRepository

removeUserTokens

public void removeUserTokens(String username)

Description copied from interface: PersistentTokenRepository

Forgets every series of a user: every browser they were remembered in.

Specified by:

removeUserTokens in interface PersistentTokenRepository

deleteExpired

public int deleteExpired(long now,
 long olderThanSeconds)
                  throws IOException

Deletes the series last used more than olderThanSeconds ago: for a scheduled job, since a cookie nobody presents again leaves its row behind.

Parameters:

now - epoch milliseconds

Returns:

how many were deleted

Throws:

IOException