Package rife.authentication.remembermanagers

Class DatabaseRemember

java.lang.Object

rife.database.DbQueryManager

rife.authentication.remembermanagers.DatabaseRemember

All Implemented Interfaces:

Cloneable, RememberManager

public abstract class DatabaseRemember
extends DbQueryManager
implements RememberManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatabaseRemember(Datasource datasource)

Method Summary

Modifier and Type	Method	Description
protected String	_createRememberId(Insert createRememberId, long userId)
protected void	_eraseAllRememberIds(Delete eraseAllRememberIds)
protected boolean	_eraseRememberId(Delete eraseRememberId, String rememberId)
protected boolean	_eraseUserRememberIds(Delete eraseUserRememberIds, long userId)
protected long	_getRememberedUserId(Select getRememberedUserId, String rememberId)
protected boolean	_install(CreateTable createRemember, String createRememberMomentIndex)
protected void	_purgeRememberIds(Delete purgeRememberIds)
protected boolean	_remove(DropTable removeRemember, String removeRememberMomentIndex)
long	getRememberDuration()	Obtains the maximum time that a remember ID can be used before it becomes invalid.
int	getRememberPurgeFrequency()	Obtains the frequency at which the purging will happen in relationship to the scale.
int	getRememberPurgeScale()	Obtains the scale at which the purging will happen in relationship to the frequency.
abstract boolean	install()
abstract boolean	remove()
void	setRememberDuration(long milliseconds)	Sets the maximum time that a remember ID can be used before it becomes invalid.
void	setRememberPurgeFrequency(int frequency)	Set the frequency at which the purging will happen in relationship to the scale.
void	setRememberPurgeScale(int scale)	Set the scale at which the purging will happen in relationship to the frequency.

Methods inherited from class rife.database.DbQueryManager

clone, executeFetchAll, executeFetchAll, executeFetchAll, executeFetchAll, executeFetchAllBeans, executeFetchAllBeans, executeFetchFirst, executeFetchFirst, executeFetchFirst, executeFetchFirst, executeFetchFirstBean, executeFetchFirstBean, executeGetFirstBoolean, executeGetFirstBoolean, executeGetFirstByte, executeGetFirstByte, executeGetFirstBytes, executeGetFirstBytes, executeGetFirstDate, executeGetFirstDate, executeGetFirstDate, executeGetFirstDate, executeGetFirstDouble, executeGetFirstDouble, executeGetFirstFloat, executeGetFirstFloat, executeGetFirstInt, executeGetFirstInt, executeGetFirstLong, executeGetFirstLong, executeGetFirstShort, executeGetFirstShort, executeGetFirstString, executeGetFirstString, executeGetFirstTime, executeGetFirstTime, executeGetFirstTime, executeGetFirstTime, executeGetFirstTimestamp, executeGetFirstTimestamp, executeGetFirstTimestamp, executeGetFirstTimestamp, executeHasResultRows, executeHasResultRows, executeQuery, executeQuery, executeResultQuery, executeUpdate, executeUpdate, executeUpdate, executeUseFirstAsciiStream, executeUseFirstAsciiStream, executeUseFirstBinaryStream, executeUseFirstBinaryStream, executeUseFirstCharacterStream, executeUseFirstCharacterStream, fetch, fetch, fetch, fetchAll, fetchAll, getConnection, getDatasource, inTransaction, inTransaction, reserveConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface rife.authentication.RememberManager

createRememberId, eraseAllRememberIds, eraseRememberId, eraseUserRememberIds, getRememberedUserId, purgeRememberIds

Constructor Details

DatabaseRemember

protected DatabaseRemember(Datasource datasource)

Method Details

getRememberDuration

public long getRememberDuration()

Description copied from interface: RememberManager

Obtains the maximum time that a remember ID can be used before it becomes invalid.

Specified by:

getRememberDuration in interface RememberManager

Returns:

The maximum lifetime in milliseconds.

setRememberDuration

public void setRememberDuration(long milliseconds)

Description copied from interface: RememberManager

Sets the maximum time that a remember ID can be used before it becomes invalid.

Specified by:

setRememberDuration in interface RememberManager

Parameters:

milliseconds - The lifetime in milliseconds.

getRememberPurgeFrequency

public int getRememberPurgeFrequency()

Description copied from interface: RememberManager

Obtains the frequency at which the purging will happen in relationship to the scale.

This defaults to RifeConfig.AuthenticationConfig.getRememberPurgeFrequency().

Specified by:

getRememberPurgeFrequency in interface RememberManager

Returns:

the purge frequency

See Also:

• RememberManager.setRememberPurgeFrequency(int)
• RememberManager.getRememberPurgeScale()
• RememberManager.setRememberPurgeScale(int)

setRememberPurgeFrequency

public void setRememberPurgeFrequency(int frequency)

Description copied from interface: RememberManager

Set the frequency at which the purging will happen in relationship to the scale.

By default, the frequency and scale respectively are 20 and 1000, which means that the purging will have once every fifty times the remember sessions are accessed.

Specified by:

setRememberPurgeFrequency in interface RememberManager

Parameters:

frequency - the purge frequency

See Also:

• RememberManager.getRememberPurgeFrequency()
• RememberManager.getRememberPurgeScale()
• RememberManager.setRememberPurgeScale(int)

getRememberPurgeScale

public int getRememberPurgeScale()

Description copied from interface: RememberManager

Obtains the scale at which the purging will happen in relationship to the frequency.

This defaults to RifeConfig.AuthenticationConfig.getRememberPurgeScale().

Specified by:

getRememberPurgeScale in interface RememberManager

Returns:

the purge scale

See Also:

• RememberManager.getRememberPurgeFrequency()
• RememberManager.setRememberPurgeFrequency(int)
• RememberManager.setRememberPurgeScale(int)

setRememberPurgeScale

public void setRememberPurgeScale(int scale)

Description copied from interface: RememberManager

Set the scale at which the purging will happen in relationship to the frequency.

By default, the frequency and scale respectively are 20 and 1000, which means that the purging will have once every fifty times the remember sessions are accessed.

Specified by:

setRememberPurgeScale in interface RememberManager

Parameters:

scale - the purge scale

See Also:

• RememberManager.getRememberPurgeFrequency()
• RememberManager.setRememberPurgeFrequency(int)
• RememberManager.getRememberPurgeScale()

install

public abstract boolean install()
                         throws RememberManagerException

Throws:

RememberManagerException

remove

public abstract boolean remove()
                        throws RememberManagerException

Throws:

RememberManagerException

_install

protected boolean _install(CreateTable createRemember,
 String createRememberMomentIndex)

_remove

protected boolean _remove(DropTable removeRemember,
 String removeRememberMomentIndex)

_createRememberId

protected String _createRememberId(Insert createRememberId,
 long userId)
                            throws RememberManagerException

Throws:

RememberManagerException

_eraseRememberId

protected boolean _eraseRememberId(Delete eraseRememberId,
 String rememberId)
                            throws RememberManagerException

Throws:

RememberManagerException

_eraseUserRememberIds

protected boolean _eraseUserRememberIds(Delete eraseUserRememberIds,
 long userId)
                                 throws RememberManagerException

Throws:

RememberManagerException

_eraseAllRememberIds

protected void _eraseAllRememberIds(Delete eraseAllRememberIds)
                             throws RememberManagerException

Throws:

RememberManagerException

_getRememberedUserId

protected long _getRememberedUserId(Select getRememberedUserId,
 String rememberId)
                             throws RememberManagerException

Throws:

RememberManagerException

_purgeRememberIds

protected void _purgeRememberIds(Delete purgeRememberIds)
                          throws RememberManagerException

Throws:

RememberManagerException