Package rife.authentication.sessionmanagers

Class DatabaseSessions

java.lang.Object

rife.database.DbQueryManager

rife.authentication.sessionmanagers.DatabaseSessions

All Implemented Interfaces:

Cloneable, SessionManager

public abstract class DatabaseSessions
extends DbQueryManager
implements SessionManager

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DatabaseSessions(Datasource datasource)

Method Summary

Modifier and Type	Method	Description
boolean	_continueSession(Update continueSession, String authId)
protected long	_countSessions(Select countSessions)
protected void	_eraseAllSessions(Delete eraseAllSessions)
protected boolean	_eraseSession(Delete eraseSession, String authId)
protected boolean	_eraseUserSessions(Delete eraseUserSessions, long userId)
protected long	_getSessionUserId(Select getSessionUserId, String authId)
protected boolean	_install(CreateTable createAuthentication, String createAuthenticationSessStartIndex)
protected boolean	_isSessionValid(Select sessionValidity, Select sessionValidityRestrictAuthData, String authId, String authData)
protected boolean	_listSessions(Select listSessions, ListSessions processor)
protected void	_purgeSessions(Delete purgeSession)
protected boolean	_remove(DropTable removeAuthentication, String removeAuthenticationSessStartIndex)
protected String	_startSession(Insert startSession, long userId, String authData, boolean remembered)
protected boolean	_wasRemembered(Select wasRemembered, String authId)
abstract long	countSessions()	Counts the number of active sessions.
boolean	getRestrictAuthData()	Obtains the restriction policy of the authentication ID in regard to the user's auth data.
long	getSessionDuration()	Obtains the maximum time that a user can stay inactive before an active session becomes invalid.
int	getSessionPurgeFrequency()	Obtains the frequency at which the purging will happen in relationship to the scale.
int	getSessionPurgeScale()	Obtains the scale at which the purging will happen in relationship to the frequency.
abstract boolean	install()
abstract boolean	remove()
void	setRestrictAuthData(boolean flag)	Sets the restriction policy of the authentication ID in regard to the user's auth data.
void	setSessionDuration(long milliseconds)	Sets the maximum time that a user can stay inactive before an active session becomes invalid.
void	setSessionPurgeFrequency(int frequency)	Set the frequency at which the purging will happen in relationship to the scale.
void	setSessionPurgeScale(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.SessionManager

continueSession, eraseAllSessions, eraseSession, eraseUserSessions, getSessionUserId, isSessionValid, listSessions, purgeSessions, startSession, wasRemembered

Constructor Details

DatabaseSessions

protected DatabaseSessions(Datasource datasource)

Method Details

getSessionDuration

public long getSessionDuration()

Description copied from interface: SessionManager

Obtains the maximum time that a user can stay inactive before an active session becomes invalid.

Specified by:

getSessionDuration in interface SessionManager

Returns:

The maximum time of inactivity in milliseconds.

setSessionDuration

public void setSessionDuration(long milliseconds)

Description copied from interface: SessionManager

Sets the maximum time that a user can stay inactive before an active session becomes invalid.

Specified by:

setSessionDuration in interface SessionManager

Parameters:

milliseconds - The maximum time of inactivity in milliseconds.

getRestrictAuthData

public boolean getRestrictAuthData()

Description copied from interface: SessionManager

Obtains the restriction policy of the authentication ID in regard to the user's auth data.

The default is false, or no restriction.

Specified by:

getRestrictAuthData in interface SessionManager

Returns:

true if the authentication is restricted to one auth data; or

false if the authentication ID can be used with any auth data

setRestrictAuthData

public void setRestrictAuthData(boolean flag)

Description copied from interface: SessionManager

Sets the restriction policy of the authentication ID in regard to the user's auth data.

The default is false, or no restriction.

Specified by:

setRestrictAuthData in interface SessionManager

Parameters:

flag - true to activate the auth data restriction; or

false otherwise

getSessionPurgeFrequency

public int getSessionPurgeFrequency()

Description copied from interface: SessionManager

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

This defaults to RifeConfig.AuthenticationConfig.getSessionPurgeFrequency().

Specified by:

getSessionPurgeFrequency in interface SessionManager

Returns:

the purge frequency

See Also:

• SessionManager.setSessionPurgeFrequency(int)
• SessionManager.getSessionPurgeScale()
• SessionManager.setSessionPurgeScale(int)

setSessionPurgeFrequency

public void setSessionPurgeFrequency(int frequency)

Description copied from interface: SessionManager

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 authentication sessions are accessed.

Specified by:

setSessionPurgeFrequency in interface SessionManager

Parameters:

frequency - the purge frequency

See Also:

• SessionManager.getSessionPurgeFrequency()
• SessionManager.getSessionPurgeScale()
• SessionManager.setSessionPurgeScale(int)

getSessionPurgeScale

public int getSessionPurgeScale()

Description copied from interface: SessionManager

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

This defaults to RifeConfig.AuthenticationConfig.getSessionPurgeScale().

Specified by:

getSessionPurgeScale in interface SessionManager

Returns:

the purge scale

See Also:

• SessionManager.getSessionPurgeFrequency()
• SessionManager.setSessionPurgeFrequency(int)
• SessionManager.setSessionPurgeScale(int)

setSessionPurgeScale

public void setSessionPurgeScale(int scale)

Description copied from interface: SessionManager

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 authentication sessions are accessed.

Specified by:

setSessionPurgeScale in interface SessionManager

Parameters:

scale - the purge scale

See Also:

• SessionManager.getSessionPurgeFrequency()
• SessionManager.setSessionPurgeFrequency(int)
• SessionManager.getSessionPurgeScale()

install

public abstract boolean install()
                         throws SessionManagerException

Throws:

SessionManagerException

remove

public abstract boolean remove()
                        throws SessionManagerException

Throws:

SessionManagerException

countSessions

public abstract long countSessions()
                            throws SessionManagerException

Description copied from interface: SessionManager

Counts the number of active sessions.

Specified by:

countSessions in interface SessionManager

Returns:

The number of active sessions.

Throws:

SessionManagerException - An undefined number of exceptional cases or error situations can occur when a session is counted. They are all indicated by throwing an instance of SessionManagerException. It's up to the implementations of this interface to give more specific meanings to these exceptions.

_install

protected boolean _install(CreateTable createAuthentication,
 String createAuthenticationSessStartIndex)

_remove

protected boolean _remove(DropTable removeAuthentication,
 String removeAuthenticationSessStartIndex)

_purgeSessions

protected void _purgeSessions(Delete purgeSession)
                       throws SessionManagerException

Throws:

SessionManagerException

_startSession

protected String _startSession(Insert startSession,
 long userId,
 String authData,
 boolean remembered)
                        throws SessionManagerException

Throws:

SessionManagerException

_isSessionValid

protected boolean _isSessionValid(Select sessionValidity,
 Select sessionValidityRestrictAuthData,
 String authId,
 String authData)
                           throws SessionManagerException

Throws:

SessionManagerException

_continueSession

public boolean _continueSession(Update continueSession,
 String authId)
                         throws SessionManagerException

Throws:

SessionManagerException

_eraseSession

protected boolean _eraseSession(Delete eraseSession,
 String authId)
                         throws SessionManagerException

Throws:

SessionManagerException

_wasRemembered

protected boolean _wasRemembered(Select wasRemembered,
 String authId)
                          throws SessionManagerException

Throws:

SessionManagerException

_eraseUserSessions

protected boolean _eraseUserSessions(Delete eraseUserSessions,
 long userId)
                              throws SessionManagerException

Throws:

SessionManagerException

_eraseAllSessions

protected void _eraseAllSessions(Delete eraseAllSessions)
                          throws SessionManagerException

Throws:

SessionManagerException

_countSessions

protected long _countSessions(Select countSessions)
                       throws SessionManagerException

Throws:

SessionManagerException

_getSessionUserId

protected long _getSessionUserId(Select getSessionUserId,
 String authId)
                          throws SessionManagerException

Throws:

SessionManagerException

_listSessions

protected boolean _listSessions(Select listSessions,
 ListSessions processor)
                         throws SessionManagerException

Throws:

SessionManagerException