Package org.eclipse.jetty.server.session

Class JDBCSessionIdManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.AbstractSessionIdManager

org.eclipse.jetty.server.session.JDBCSessionIdManager

All Implemented Interfaces:

SessionIdManager, org.eclipse.jetty.util.component.LifeCycle

public class JDBCSessionIdManager
extends AbstractSessionIdManager

JDBCSessionIdManager SessionIdManager implementation that uses a database to store in-use session ids, to support distributed sessions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JDBCSessionIdManager.DatabaseAdaptor	DatabaseAdaptor Handles differences between databases.
protected class	JDBCSessionIdManager.Scavenger	Scavenger
static class	JDBCSessionIdManager.SessionIdTableSchema	SessionIdTableSchema
static class	JDBCSessionIdManager.SessionTableSchema	SessionTableSchema

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	_connectionUrl
protected java.lang.String	_createSessionIdTable
protected java.lang.String	_createSessionTable
protected javax.sql.DataSource	_datasource
protected JDBCSessionIdManager.DatabaseAdaptor	_dbAdaptor
protected int	_deleteBlockSize
protected java.lang.String	_deleteId
protected java.lang.String	_deleteSession
protected java.sql.Driver	_driver
protected java.lang.String	_driverClassName
protected java.lang.String	_insertId
protected java.lang.String	_insertSession
protected java.lang.String	_jndiName
protected long	_lastScavengeTime
protected boolean	_ownScheduler
protected java.lang.String	_queryId
protected long	_scavengeIntervalMs
protected JDBCSessionIdManager.Scavenger	_scavenger
protected org.eclipse.jetty.util.thread.Scheduler	_scheduler
protected java.lang.String	_selectBoundedExpiredSessions
protected Server	_server
protected java.util.HashSet<java.lang.String>	_sessionIds
protected JDBCSessionIdManager.SessionIdTableSchema	_sessionIdTableSchema
protected JDBCSessionIdManager.SessionTableSchema	_sessionTableSchema
protected org.eclipse.jetty.util.thread.Scheduler.Task	_task
protected java.lang.String	_updateSession
protected java.lang.String	_updateSessionAccessTime
protected java.lang.String	_updateSessionNode
static int	MAX_INTERVAL_NOT_SET

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Fields inherited from class org.eclipse.jetty.server.session.AbstractSessionIdManager

_random, _reseed, _weakRandom, _workerAttr, _workerName

Constructor Summary

Constructors

Constructor	Description
JDBCSessionIdManager(Server server)
JDBCSessionIdManager(Server server, java.util.Random random)

Method Summary

Modifier and Type	Method	Description
void	addSession(java.lang.String id)
void	addSession(javax.servlet.http.HttpSession session)	Add a session to the list of known sessions for a given ID.
void	doStart()	Start up the id manager.
void	doStop()	Stop the scavenger.
java.lang.String	getBlobType()	Deprecated. see DbAdaptor.getBlobType
protected java.sql.Connection	getConnection()	Get a connection from the driver or datasource.
java.lang.String	getConnectionUrl()
javax.sql.DataSource	getDataSource()
java.lang.String	getDatasourceName()
JDBCSessionIdManager.DatabaseAdaptor	getDbAdaptor()
int	getDeleteBlockSize()
java.lang.String	getDriverClassName()
java.lang.String	getLongType()	Deprecated. see DbAdaptor.getLogType
long	getScavengeInterval()
JDBCSessionIdManager.SessionIdTableSchema	getSessionIdTableSchema()
JDBCSessionIdManager.SessionTableSchema	getSessionTableSchema()
boolean	idInUse(java.lang.String id)
void	invalidateAll(java.lang.String id)	Invalidate the session matching the id on all contexts.
void	removeSession(java.lang.String id)
void	removeSession(javax.servlet.http.HttpSession session)	Remove session from the list of known sessions for a given ID.
void	renewSessionId(java.lang.String oldClusterId, java.lang.String oldNodeId, javax.servlet.http.HttpServletRequest request)	Change the existing session id.
void	setBlobType(java.lang.String name)	Deprecated. see DbAdaptor.setBlobType
void	setDatasource(javax.sql.DataSource ds)
void	setDatasourceName(java.lang.String jndi)
void	setDbAdaptor(JDBCSessionIdManager.DatabaseAdaptor dbAdaptor)
void	setDeleteBlockSize(int bsize)
void	setDriverInfo(java.lang.String driverClassName, java.lang.String connectionUrl)	Configure jdbc connection information via a jdbc Driver
void	setDriverInfo(java.sql.Driver driverClass, java.lang.String connectionUrl)	Configure jdbc connection information via a jdbc Driver
void	setLongType(java.lang.String longType)	Deprecated. see DbAdaptor.setLongType
void	setScavengeInterval(long sec)
void	setSessionIdTableSchema(JDBCSessionIdManager.SessionIdTableSchema sessionIdTableSchema)
void	setSessionTableSchema(JDBCSessionIdManager.SessionTableSchema sessionTableSchema)

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class org.eclipse.jetty.server.session.AbstractSessionIdManager

getClusterId, getNodeId, getRandom, getReseed, getWorkerName, initRandom, newSessionId, newSessionId, setRandom, setReseed, setWorkerName

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

MAX_INTERVAL_NOT_SET

public static final int MAX_INTERVAL_NOT_SET

See Also:

Constant Field Values

_sessionIds

protected final java.util.HashSet<java.lang.String> _sessionIds

_server

protected Server _server

_driver

protected java.sql.Driver _driver

_driverClassName

protected java.lang.String _driverClassName

_connectionUrl

protected java.lang.String _connectionUrl

_datasource

protected javax.sql.DataSource _datasource

_jndiName

protected java.lang.String _jndiName

_deleteBlockSize

protected int _deleteBlockSize

_task

protected org.eclipse.jetty.util.thread.Scheduler.Task _task

_scheduler

protected org.eclipse.jetty.util.thread.Scheduler _scheduler

_scavenger

protected JDBCSessionIdManager.Scavenger _scavenger

_ownScheduler

protected boolean _ownScheduler

_lastScavengeTime

protected long _lastScavengeTime

_scavengeIntervalMs

protected long _scavengeIntervalMs

_createSessionIdTable

protected java.lang.String _createSessionIdTable

_createSessionTable

protected java.lang.String _createSessionTable

_selectBoundedExpiredSessions

protected java.lang.String _selectBoundedExpiredSessions

_insertId

protected java.lang.String _insertId

_deleteId

protected java.lang.String _deleteId

_queryId

protected java.lang.String _queryId

_insertSession

protected java.lang.String _insertSession

_deleteSession

protected java.lang.String _deleteSession

_updateSession

protected java.lang.String _updateSession

_updateSessionNode

protected java.lang.String _updateSessionNode

_updateSessionAccessTime

protected java.lang.String _updateSessionAccessTime

_dbAdaptor

protected JDBCSessionIdManager.DatabaseAdaptor _dbAdaptor

_sessionIdTableSchema

protected JDBCSessionIdManager.SessionIdTableSchema _sessionIdTableSchema

_sessionTableSchema

protected JDBCSessionIdManager.SessionTableSchema _sessionTableSchema

Constructor Detail

JDBCSessionIdManager

public JDBCSessionIdManager(Server server)

JDBCSessionIdManager

public JDBCSessionIdManager(Server server,
                            java.util.Random random)

Method Detail

setDriverInfo

public void setDriverInfo(java.lang.String driverClassName,
                          java.lang.String connectionUrl)

Configure jdbc connection information via a jdbc Driver

Parameters:

driverClassName - the driver classname

connectionUrl - the driver connection url

setDriverInfo

public void setDriverInfo(java.sql.Driver driverClass,
                          java.lang.String connectionUrl)

Configure jdbc connection information via a jdbc Driver

Parameters:

driverClass - the driver class

connectionUrl - the driver connection url

setDatasource

public void setDatasource(javax.sql.DataSource ds)

getDataSource

public javax.sql.DataSource getDataSource()

getDriverClassName

public java.lang.String getDriverClassName()

getConnectionUrl

public java.lang.String getConnectionUrl()

setDatasourceName

public void setDatasourceName(java.lang.String jndi)

getDatasourceName

public java.lang.String getDatasourceName()

setBlobType

@Deprecated
public void setBlobType(java.lang.String name)

Deprecated. see DbAdaptor.setBlobType

Parameters:

name - the name of the blob

getDbAdaptor

public JDBCSessionIdManager.DatabaseAdaptor getDbAdaptor()

setDbAdaptor

public void setDbAdaptor(JDBCSessionIdManager.DatabaseAdaptor dbAdaptor)

getBlobType

@Deprecated
public java.lang.String getBlobType()

Deprecated. see DbAdaptor.getBlobType

Returns:

the blob type

getLongType

@Deprecated
public java.lang.String getLongType()

Deprecated. see DbAdaptor.getLogType

Returns:

the long type

setLongType

@Deprecated
public void setLongType(java.lang.String longType)

Deprecated. see DbAdaptor.setLongType

Parameters:

longType - the long type

getSessionIdTableSchema

public JDBCSessionIdManager.SessionIdTableSchema getSessionIdTableSchema()

setSessionIdTableSchema

public void setSessionIdTableSchema(JDBCSessionIdManager.SessionIdTableSchema sessionIdTableSchema)

getSessionTableSchema

public JDBCSessionIdManager.SessionTableSchema getSessionTableSchema()

setSessionTableSchema

public void setSessionTableSchema(JDBCSessionIdManager.SessionTableSchema sessionTableSchema)

setDeleteBlockSize

public void setDeleteBlockSize(int bsize)

getDeleteBlockSize

public int getDeleteBlockSize()

setScavengeInterval

public void setScavengeInterval(long sec)

getScavengeInterval

public long getScavengeInterval()

addSession

public void addSession(javax.servlet.http.HttpSession session)

Description copied from interface: SessionIdManager

Add a session to the list of known sessions for a given ID.

Parameters:

session - The session

addSession

public void addSession(java.lang.String id)

removeSession

public void removeSession(javax.servlet.http.HttpSession session)

Description copied from interface: SessionIdManager

Remove session from the list of known sessions for a given ID.

Parameters:

session - the session to remove

removeSession

public void removeSession(java.lang.String id)

idInUse

public boolean idInUse(java.lang.String id)

Parameters:

id - The session ID without any cluster node extension

Returns:

True if the session ID is in use by at least one context.

invalidateAll

public void invalidateAll(java.lang.String id)

Invalidate the session matching the id on all contexts.

Parameters:

id - The session ID without any cluster node extension

See Also:

SessionIdManager.invalidateAll(java.lang.String)

renewSessionId

public void renewSessionId(java.lang.String oldClusterId,
                           java.lang.String oldNodeId,
                           javax.servlet.http.HttpServletRequest request)

Description copied from interface: SessionIdManager

Change the existing session id.

Specified by:

renewSessionId in interface SessionIdManager

Specified by:

renewSessionId in class AbstractSessionIdManager

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

request - the request containing the session

doStart

public void doStart()
             throws java.lang.Exception

Start up the id manager. Makes necessary database tables and starts a Session scavenger thread.

Overrides:

doStart in class AbstractSessionIdManager

Throws:

java.lang.Exception

doStop

public void doStop()
            throws java.lang.Exception

Stop the scavenger.

Overrides:

doStop in class AbstractSessionIdManager

Throws:

java.lang.Exception

getConnection

protected java.sql.Connection getConnection()
                                     throws java.sql.SQLException

Get a connection from the driver or datasource.

Returns:

the connection for the datasource

Throws:

java.sql.SQLException - if unable to get the connection