Modifier and Type	Class and Description
public class	JDBCSessionIdManager.DatabaseAdaptor DatabaseAdaptor Handles differences between databases.

Modifier and Type	Field and Description
protected String	_connectionUrl
protected String	_createSessionIdTable
protected String	_createSessionTable
protected DataSource	_datasource
protected JDBCSessionIdManager.DatabaseAdaptor	_dbAdaptor
protected String	_deleteId
protected String	_deleteOldExpiredSessions
protected String	_driverClassName
protected String	_insertId
protected String	_jndiName
protected long	_lastScavengeTime
protected String	_queryId
protected long	_scavengeIntervalMs
protected String	_selectExpiredSessions
protected HashSet<String>	_sessionIds
protected String	_sessionIdTable
protected String	_sessionTable
protected TimerTask	_task
protected Timer	_timer

Access	Constructor and Description
public	JDBCSessionIdManager(Server server)
public	JDBCSessionIdManager(Server server, Random random)

Method Summary

Modifier and Type	Method and Description
public void	addSession(HttpSession The session session) Implements org.mortbay.jetty.SessionIdManager.addSession. Add a session to the list of known sessions for a given ID.
private void	delete(String id) Remove a session id from the table.
public void	doStart() Overrides org.mortbay.jetty.servlet.AbstractSessionIdManager.doStart. Start up the id manager.
public void	doStop() Overrides org.mortbay.component.AbstractLifeCycle.doStop. Stop the scavenger.
private boolean	exists(String id) Check if a session id exists.
public String	getClusterId(String nodeId) Implements org.mortbay.jetty.SessionIdManager.getClusterId. Get the session id without any node identifier suffix.
protected Connection	getConnection() Get a connection from the driver or datasource.
public String	getConnectionUrl()
public String	getDatasourceName()
public String	getDriverClassName()
public String	getNodeId(String The ID of the session clusterId, HttpServletRequest The request that for the session (or null) request) Implements org.mortbay.jetty.SessionIdManager.getNodeId. Get the session id, including this node's id as a suffix.
public long	getScavengeInterval()
public boolean	idInUse(String The session ID without any cluster node extension id) Implements org.mortbay.jetty.SessionIdManager.idInUse.
private void	initializeDatabase()
private void	insert(String id) Insert a new used session id into the table.
public void	invalidateAll(String The session ID without any cluster node extension id) Implements org.mortbay.jetty.SessionIdManager.invalidateAll. Invalidate the session matching the id on all contexts.
private void	prepareTables() Set up the tables in the database
public void	removeSession(HttpSession session) Implements org.mortbay.jetty.SessionIdManager.removeSession. Remove session from the list of known sessions for a given ID.
public void	removeSession(String id)
private void	scavenge() Look for sessions in the database that have expired.
public void	setDatasourceName(String jndi)
public void	setDriverInfo(String driverClassName, String connectionUrl) Configure jdbc connection information via a jdbc Driver
public void	setScavengeInterval(long sec)

Inherited from org.mortbay.jetty.servlet.AbstractSessionIdManager:: getRandom getWorkerName initRandom newSessionId setRandom setWorkerName

Field Detail

_connectionUrl	back to summary
protected String _connectionUrl

_createSessionIdTable	back to summary
protected String _createSessionIdTable

_createSessionTable	back to summary
protected String _createSessionTable

_datasource	back to summary
protected DataSource _datasource

_dbAdaptor	back to summary
protected JDBCSessionIdManager.DatabaseAdaptor _dbAdaptor

_deleteId	back to summary
protected String _deleteId

_deleteOldExpiredSessions	back to summary
protected String _deleteOldExpiredSessions

_driverClassName	back to summary
protected String _driverClassName

_insertId	back to summary
protected String _insertId

_jndiName	back to summary
protected String _jndiName

_lastScavengeTime	back to summary
protected long _lastScavengeTime

_queryId	back to summary
protected String _queryId

_scavengeIntervalMs	back to summary
protected long _scavengeIntervalMs

_selectExpiredSessions	back to summary
protected String _selectExpiredSessions

_sessionIds	back to summary
protected HashSet<String> _sessionIds

_sessionIdTable	back to summary
protected String _sessionIdTable

_sessionTable	back to summary
protected String _sessionTable

_task	back to summary
protected TimerTask _task

_timer	back to summary
protected Timer _timer

Constructor Detail

JDBCSessionIdManager	back to summary
public JDBCSessionIdManager(Server server)

JDBCSessionIdManager	back to summary
public JDBCSessionIdManager(Server server, Random random)

Method Detail

addSession	back to summary
public void addSession(HttpSession session) Implements org.mortbay.jetty.SessionIdManager.addSession. Doc from org.mortbay.jetty.SessionIdManager.addSession. Add a session to the list of known sessions for a given ID. Parameters session:HttpSession The session

addSession

back to summary

public void addSession(HttpSession session)

Implements org.mortbay.jetty.SessionIdManager.addSession.

Doc from org.mortbay.jetty.SessionIdManager.addSession.

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

Parameters

session:HttpSession: The session

delete	back to summary
private void delete(String id) throws SQLException Remove a session id from the table.

doStart back to summary

doStart	back to summary
public void doStart() Overrides org.mortbay.jetty.servlet.AbstractSessionIdManager.doStart. Start up the id manager. Makes necessary database tables and starts a Session scavenger thread. See Also `org.mortbay.jetty.servlet.AbstractSessionIdManager#doStart()`

public void doStart()

Overrides org.mortbay.jetty.servlet.AbstractSessionIdManager.doStart.

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

See Also: org.mortbay.jetty.servlet.AbstractSessionIdManager#doStart()

doStop back to summary

doStop	back to summary
public void doStop() throws Exception Overrides org.mortbay.component.AbstractLifeCycle.doStop. Stop the scavenger. See Also `org.mortbay.component.AbstractLifeCycle#doStop()`

public void doStop() throws Exception

Overrides org.mortbay.component.AbstractLifeCycle.doStop.

Stop the scavenger.

See Also: org.mortbay.component.AbstractLifeCycle#doStop()

exists	back to summary
private boolean exists(String id) throws SQLException Check if a session id exists.

getClusterId back to summary

getClusterId	back to summary
public String getClusterId(String nodeId) Implements org.mortbay.jetty.SessionIdManager.getClusterId. Get the session id without any node identifier suffix. See Also `org.mortbay.jetty.SessionIdManager#getClusterId(java.lang.String)`

public String getClusterId(String nodeId)

Implements org.mortbay.jetty.SessionIdManager.getClusterId.

Get the session id without any node identifier suffix.

See Also: org.mortbay.jetty.SessionIdManager#getClusterId(java.lang.String)

getConnection	back to summary
protected Connection getConnection() throws SQLException Get a connection from the driver or datasource.

getConnectionUrl	back to summary
public String getConnectionUrl()

getDatasourceName	back to summary
public String getDatasourceName()

getDriverClassName	back to summary
public String getDriverClassName()

getNodeId back to summary

getNodeId	back to summary
public String getNodeId(String clusterId, HttpServletRequest request) Implements org.mortbay.jetty.SessionIdManager.getNodeId. Get the session id, including this node's id as a suffix. Parameters clusterId:String Doc from org.mortbay.jetty.SessionIdManager.getNodeId. The ID of the session request:HttpServletRequest Doc from org.mortbay.jetty.SessionIdManager.getNodeId. The request that for the session (or null) Returns:String Doc from org.mortbay.jetty.SessionIdManager.getNodeId. The session ID qualified with the node ID. See Also `org.mortbay.jetty.SessionIdManager#getNodeId(java.lang.String, javax.servlet.http.HttpServletRequest)`

public String getNodeId(String clusterId, HttpServletRequest request)

Implements org.mortbay.jetty.SessionIdManager.getNodeId.

Get the session id, including this node's id as a suffix.

Parameters

clusterId:String

Doc from org.mortbay.jetty.SessionIdManager.getNodeId.

The ID of the session

request:HttpServletRequest

Doc from org.mortbay.jetty.SessionIdManager.getNodeId.

The request that for the session (or null)

Returns:String

Doc from org.mortbay.jetty.SessionIdManager.getNodeId.

The session ID qualified with the node ID.

getScavengeInterval	back to summary
public long getScavengeInterval()

idInUse	back to summary
public boolean idInUse(String id) Implements org.mortbay.jetty.SessionIdManager.idInUse. Parameters id:String Doc from org.mortbay.jetty.SessionIdManager.idInUse. The session ID without any cluster node extension Returns:boolean Doc from org.mortbay.jetty.SessionIdManager.idInUse. True if the session ID is in use by at least one context.

idInUse

back to summary

public boolean idInUse(String id)

Implements org.mortbay.jetty.SessionIdManager.idInUse.

Parameters

id:String

Doc from org.mortbay.jetty.SessionIdManager.idInUse.

The session ID without any cluster node extension

Returns:boolean

Doc from org.mortbay.jetty.SessionIdManager.idInUse.

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

initializeDatabase	back to summary
private void initializeDatabase() throws Exception

insert	back to summary
private void insert(String id) throws SQLException Insert a new used session id into the table.

invalidateAll back to summary

invalidateAll	back to summary
public void invalidateAll(String id) Implements org.mortbay.jetty.SessionIdManager.invalidateAll. Invalidate the session matching the id on all contexts. Parameters id:String Doc from org.mortbay.jetty.SessionIdManager.invalidateAll. The session ID without any cluster node extension See Also `org.mortbay.jetty.SessionIdManager#invalidateAll(java.lang.String)`

public void invalidateAll(String id)

Implements org.mortbay.jetty.SessionIdManager.invalidateAll.

Invalidate the session matching the id on all contexts.

Parameters

id:String

Doc from org.mortbay.jetty.SessionIdManager.invalidateAll.

The session ID without any cluster node extension

prepareTables	back to summary
private void prepareTables() throws SQLException Set up the tables in the database

removeSession	back to summary
public void removeSession(HttpSession session) Implements org.mortbay.jetty.SessionIdManager.removeSession. Doc from org.mortbay.jetty.SessionIdManager.removeSession. Remove session from the list of known sessions for a given ID.

removeSession

back to summary

public void removeSession(HttpSession session)

Implements org.mortbay.jetty.SessionIdManager.removeSession.

Doc from org.mortbay.jetty.SessionIdManager.removeSession.

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

removeSession	back to summary
public void removeSession(String id)

scavenge	back to summary
private void scavenge() Look for sessions in the database that have expired. We do this in the SessionIdManager and not the SessionManager so that we only have 1 scavenger, otherwise if there are n SessionManagers there would be n scavengers, all contending for the database. We look first for sessions that expired in the previous interval, then for sessions that expired previously - these are old sessions that no node is managing any more and have become stuck in the database.

scavenge

back to summary

private void scavenge()

Look for sessions in the database that have expired. We do this in the SessionIdManager and not the SessionManager so that we only have 1 scavenger, otherwise if there are n SessionManagers there would be n scavengers, all contending for the database. We look first for sessions that expired in the previous interval, then for sessions that expired previously - these are old sessions that no node is managing any more and have become stuck in the database.

setDatasourceName	back to summary
public void setDatasourceName(String jndi)

setDriverInfo	back to summary
public void setDriverInfo(String driverClassName, String connectionUrl) Configure jdbc connection information via a jdbc Driver

setScavengeInterval	back to summary
public void setScavengeInterval(long sec)

org.mortbay.jetty.servlet back to summary

public Class JDBCSessionIdManager.DatabaseAdaptor

Class Inheritance

extends Object

java.lang.Object
org.mortbay.jetty.servlet.JDBCSessionIdManager.DatabaseAdaptor

DatabaseAdaptor Handles differences between databases. Postgres uses the getBytes and setBinaryStream methods to access a "bytea" datatype, which can be up to 1Gb of binary data. MySQL is happy to use the "blob" type and getBlob() methods instead. TODO if the differences become more major it would be worthwhile refactoring this class.

Field Summary

Modifier and Type	Field and Description
pack-priv String	_dbName
pack-priv boolean	_isLower
pack-priv boolean	_isUpper

Constructor Summary

Access	Constructor and Description
public	DatabaseAdaptor(DatabaseMetaData dbMeta)

Method Summary

Modifier and Type	Method and Description
public String	convertIdentifier(String identifier) Convert a camel case identifier into either upper or lower depending on the way the db stores identifiers.
public InputStream	getBlobInputStream(ResultSet result, String columnName)
public String	getBlobType()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_dbName	back to summary
pack-priv String _dbName

_isLower	back to summary
pack-priv boolean _isLower

_isUpper	back to summary
pack-priv boolean _isUpper

Constructor Detail

DatabaseAdaptor	back to summary
public DatabaseAdaptor(DatabaseMetaData dbMeta) throws SQLException

Method Detail

convertIdentifier	back to summary
public String convertIdentifier(String identifier) Convert a camel case identifier into either upper or lower depending on the way the db stores identifiers.

getBlobInputStream	back to summary
public InputStream getBlobInputStream(ResultSet result, String columnName) throws SQLException

getBlobType	back to summary
public String getBlobType()

public Class JDBCSessionIdManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class JDBCSessionIdManager.DatabaseAdaptor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail