Modifier and Type	Class and Description
public static class	JDBCSessionDataStore.SessionTableSchema SessionTableSchema

Modifier and Type	Field and Description
protected DatabaseAdaptor	_dbAdaptor
protected boolean	_initialized
protected boolean	_schemaProvided
protected JDBCSessionDataStore.SessionTableSchema	_sessionTableSchema
private static final ByteArrayInputStream	EMPTY
private static final Logger	LOG Hides org.eclipse.jetty.session.AbstractSessionDataStore.LOG.
public static final String	NULL_CONTEXT_PATH Used for Oracle and other databases where "" is treated as NULL

Access	Constructor and Description
public	JDBCSessionDataStore()

Method Summary

Modifier and Type	Method and Description
public boolean	delete(String identity of session to delete id) Implements org.eclipse.jetty.session.SessionDataMap.delete. Delete session data
public Set<String>	doCheckExpired(Set<String> the ids of sessions the SessionCache thinks has expired candidates, long the time at which to check for expiry time) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCheckExpired. Implemented by subclasses to resolve which sessions in this context that are being managed by this node that should be expired.
public void	doCleanOrphans(long the upper limit of the expiry time to check in msec time) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCleanOrphans. Implemented by subclasses to delete sessions for other contexts that expired at or before the timeLimit.
public boolean	doExists(String the session id to check id) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doExists. Check if a session for the given id exists.
public Set<String>	doGetExpired(long the upper limit of expiry times to check. Sessions expired at or before this timestamp will match. timeLimit) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doGetExpired. Implemented by subclasses to find sessions for this context in the store that expired at or before the time limit and thus not being actively managed by any node.
protected void	doInsert(String id, SessionData data)
public SessionData	doLoad(String the id of the session to load id) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doLoad. Load the session from persistent store.
protected void	doStart() Overrides org.eclipse.jetty.session.AbstractSessionDataStore.doStart. Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added.
public void	doStore(String identity of session to store id, SessionData info of the session data, long time of previous save or 0 if never saved lastSaveTime) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doStore. Store the session data persistently.
protected void	doUpdate(String id, SessionData data)
public void	initialize()
public boolean	isPassivating() Implements org.eclipse.jetty.session.SessionDataStore.isPassivating. True if this type of datastore will passivate session objects
public void	setDatabaseAdaptor(DatabaseAdaptor dbAdaptor)
public void	setSessionTableSchema(JDBCSessionDataStore.SessionTableSchema schema)

Inherited from org.eclipse.jetty.session.ObjectStreamSessionDataStore:: deserializeAttributes newObjectInputStream newObjectOutputStream serializeAttributes

Field Detail

_dbAdaptor	back to summary
protected DatabaseAdaptor _dbAdaptor

_initialized	back to summary
protected boolean _initialized

_schemaProvided	back to summary
protected boolean _schemaProvided

_sessionTableSchema	back to summary
protected JDBCSessionDataStore.SessionTableSchema _sessionTableSchema

EMPTY	back to summary
private static final ByteArrayInputStream EMPTY

LOG	back to summary
private static final Logger LOG Hides org.eclipse.jetty.session.AbstractSessionDataStore.LOG.

NULL_CONTEXT_PATH	back to summary
public static final String NULL_CONTEXT_PATH Used for Oracle and other databases where "" is treated as NULL

Constructor Detail

JDBCSessionDataStore	back to summary
public JDBCSessionDataStore()

Method Detail

delete	back to summary
public boolean delete(String id) throws Exception Implements org.eclipse.jetty.session.SessionDataMap.delete. Doc from org.eclipse.jetty.session.SessionDataMap.delete. Delete session data Parameters id:String identity of session to delete Returns:boolean true if the session was deleted Annotations @Override Exceptions Exception: if unable to delete session data

delete

back to summary

public boolean delete(String id) throws Exception

Implements org.eclipse.jetty.session.SessionDataMap.delete.

Doc from org.eclipse.jetty.session.SessionDataMap.delete.

Delete session data

Parameters

id:String: identity of session to delete

Returns:boolean

true if the session was deleted

Annotations

@Override

Exceptions

Exception:: if unable to delete session data

doCheckExpired	back to summary
public Set<String> doCheckExpired(Set<String> candidates, long time) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCheckExpired. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doCheckExpired. Implemented by subclasses to resolve which sessions in this context that are being managed by this node that should be expired. Parameters candidates:Set<String> the ids of sessions the SessionCache thinks has expired time:long the time at which to check for expiry Returns:Set<String> the reconciled set of session ids that have been checked in the store Annotations @Override

doCheckExpired

back to summary

public Set<String> doCheckExpired(Set<String> candidates, long time)

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCheckExpired.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doCheckExpired.

Implemented by subclasses to resolve which sessions in this context that are being managed by this node that should be expired.

Parameters

candidates:Set<String>: the ids of sessions the SessionCache thinks has expired
time:long: the time at which to check for expiry

Returns:Set<String>

the reconciled set of session ids that have been checked in the store

Annotations

@Override

doCleanOrphans	back to summary
public void doCleanOrphans(long time) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCleanOrphans. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doCleanOrphans. Implemented by subclasses to delete sessions for other contexts that expired at or before the timeLimit. These are 'orphaned' sessions that are no longer being actively managed by any node. These are explicitly sessions that do NOT belong to this context (other mechanisms such as doGetExpired take care of those). As they don't belong to this context, they cannot be loaded by us. This is called only periodically to avoid placing excessive load on the store. Parameters time:long the upper limit of the expiry time to check in msec Annotations @Override

doCleanOrphans

back to summary

public void doCleanOrphans(long time)

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doCleanOrphans.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doCleanOrphans.

Implemented by subclasses to delete sessions for other contexts that expired at or before the timeLimit. These are 'orphaned' sessions that are no longer being actively managed by any node. These are explicitly sessions that do NOT belong to this context (other mechanisms such as doGetExpired take care of those). As they don't belong to this context, they cannot be loaded by us. This is called only periodically to avoid placing excessive load on the store.

Parameters

time:long: the upper limit of the expiry time to check in msec

Annotations

@Override

doExists	back to summary
public boolean doExists(String id) throws Exception Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doExists. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doExists. Check if a session for the given id exists. Parameters id:String the session id to check Returns:boolean true if the session exists in the persistent store, false otherwise Annotations @Override

doExists

back to summary

public boolean doExists(String id) throws Exception

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doExists.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doExists.

Check if a session for the given id exists.

Parameters

id:String: the session id to check

Returns:boolean

true if the session exists in the persistent store, false otherwise

Annotations

@Override

doGetExpired	back to summary
public Set<String> doGetExpired(long timeLimit) Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doGetExpired. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doGetExpired. Implemented by subclasses to find sessions for this context in the store that expired at or before the time limit and thus not being actively managed by any node. This method is only called periodically (the period is configurable) to avoid putting too much load on the store. Parameters timeLimit:long the upper limit of expiry times to check. Sessions expired at or before this timestamp will match. Returns:Set<String> the empty set if there are no sessions expired as at the time, or otherwise a set of session ids. Annotations @Override

doGetExpired

back to summary

public Set<String> doGetExpired(long timeLimit)

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doGetExpired.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doGetExpired.

Implemented by subclasses to find sessions for this context in the store that expired at or before the time limit and thus not being actively managed by any node. This method is only called periodically (the period is configurable) to avoid putting too much load on the store.

Parameters

timeLimit:long: the upper limit of expiry times to check. Sessions expired at or before this timestamp will match.

Returns:Set<String>

the empty set if there are no sessions expired as at the time, or otherwise a set of session ids.

Annotations

@Override

doInsert	back to summary
protected void doInsert(String id, SessionData data) throws Exception

doLoad	back to summary
public SessionData doLoad(String id) throws Exception Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doLoad. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doLoad. Load the session from persistent store. Parameters id:String the id of the session to load Returns:SessionData the re-inflated session Annotations @Override Exceptions Exception: if unable to load the session

doLoad

back to summary

public SessionData doLoad(String id) throws Exception

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doLoad.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doLoad.

Load the session from persistent store.

Parameters

id:String: the id of the session to load

Returns:SessionData

the re-inflated session

Annotations

@Override

Exceptions

Exception:: if unable to load the session

doStart	back to summary
protected void doStart() throws Exception Overrides org.eclipse.jetty.session.AbstractSessionDataStore.doStart. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

protected void doStart() throws Exception

Overrides org.eclipse.jetty.session.AbstractSessionDataStore.doStart.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Starts the managed lifecycle beans in the order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

If there was a problem starting. Will cause a transition to FAILED state

doStop	back to summary
protected void doStop() throws Exception Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop. Stops the managed lifecycle beans in the reverse order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop. If there was a problem stopping. Will cause a transition to FAILED state

doStop

back to summary

protected void doStop() throws Exception

Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Stops the managed lifecycle beans in the reverse order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

If there was a problem stopping. Will cause a transition to FAILED state

doStore	back to summary
public void doStore(String id, SessionData data, long lastSaveTime) throws Exception Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doStore. Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doStore. Store the session data persistently. Parameters id:String identity of session to store data:SessionData info of the session lastSaveTime:long time of previous save or 0 if never saved Annotations @Override Exceptions Exception: if unable to store data

doStore

back to summary

public void doStore(String id, SessionData data, long lastSaveTime) throws Exception

Implements abstract org.eclipse.jetty.session.AbstractSessionDataStore.doStore.

Doc from org.eclipse.jetty.session.AbstractSessionDataStore.doStore.

Store the session data persistently.

Parameters

id:String: identity of session to store
data:SessionData: info of the session
lastSaveTime:long: time of previous save or 0 if never saved

Annotations

@Override

Exceptions

Exception:: if unable to store data

doUpdate	back to summary
protected void doUpdate(String id, SessionData data) throws Exception

initialize	back to summary
public void initialize() throws Exception

isPassivating	back to summary
public boolean isPassivating() Implements org.eclipse.jetty.session.SessionDataStore.isPassivating. Doc from org.eclipse.jetty.session.SessionDataStore.isPassivating. True if this type of datastore will passivate session objects Returns:boolean true if this store can passivate sessions, false otherwise Annotations @Override @ManagedAttribute:does this store serialize sessions readonly:true

isPassivating

back to summary

public boolean isPassivating()

Implements org.eclipse.jetty.session.SessionDataStore.isPassivating.

Doc from org.eclipse.jetty.session.SessionDataStore.isPassivating.

True if this type of datastore will passivate session objects

Returns:boolean

true if this store can passivate sessions, false otherwise

Annotations

@Override
@ManagedAttribute:does this store serialize sessions
readonly:true

setDatabaseAdaptor	back to summary
public void setDatabaseAdaptor(DatabaseAdaptor dbAdaptor)

setSessionTableSchema	back to summary
public void setSessionTableSchema(JDBCSessionDataStore.SessionTableSchema schema)

org.eclipse.jetty.session back to summary

public Class JDBCSessionDataStore.SessionTableSchema

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.session.JDBCSessionDataStore.SessionTableSchema

SessionTableSchema

Field Summary

Modifier and Type	Field and Description
protected String	_accessTimeColumn
protected String	_catalogName
protected String	_contextPathColumn
protected String	_cookieTimeColumn
protected String	_createTimeColumn
protected DatabaseAdaptor	_dbAdaptor
protected String	_expiryTimeColumn
protected String	_idColumn
protected String	_lastAccessTimeColumn
protected String	_lastNodeColumn
protected String	_lastSavedTimeColumn
protected String	_mapColumn
protected String	_maxIntervalColumn
protected String	_schemaName
protected String	_tableName
protected String	_virtualHostColumn
public static final String	INFERRED
public static final int	MAX_INTERVAL_NOT_SET

Constructor Summary

Access	Constructor and Description
public	SessionTableSchema()

Method Summary

Modifier and Type	Method and Description
private void	checkNotNull(String s)
public String	getAccessTimeColumn()
public String	getAlterTableForMaxIntervalAsString()
public String	getCatalogName()
public PreparedStatement	getCheckSessionExistsStatement(Connection connection, SessionContext context)
public PreparedStatement	getCleanOrphansStatement(Connection connection, long timeLimit)
public String	getContextPathColumn()
public String	getCookieTimeColumn()
public String	getCreateIndexOverExpiryStatementAsString(String indexName)
public String	getCreateIndexOverSessionStatementAsString(String indexName)
public String	getCreateStatementAsString()
public String	getCreateTimeColumn()
public PreparedStatement	getDeleteStatement(Connection connection, String id, SessionContext contextId)
public PreparedStatement	getExpiredSessionsStatement(Connection connection, String canonicalContextPath, String vhost, long expiry)
public String	getExpiryTimeColumn()
public String	getIdColumn()
public String	getInsertSessionStatementAsString()
public String	getLastAccessTimeColumn()
public String	getLastNodeColumn()
public String	getLastSavedTimeColumn()
public PreparedStatement	getLoadStatement(Connection connection, String id, SessionContext contextId)
public String	getMapColumn()
public String	getMaxIntervalColumn()
public PreparedStatement	getMyExpiredSessionsStatement(Connection connection, SessionContext sessionContext, long expiry)
public String	getSchemaName()
private String	getSchemaTableName()
public String	getTableName()
public PreparedStatement	getUpdateSessionStatement(Connection connection, String id, SessionContext context)
public PreparedStatement	getUpdateStatement(Connection connection, String id, SessionContext contextId)
public String	getVirtualHostColumn()
public void	prepareTables() Set up the tables in the database
public void	setAccessTimeColumn(String accessTimeColumn)
public void	setCatalogName(String catalogName)
public void	setContextPathColumn(String contextPathColumn)
public void	setCookieTimeColumn(String cookieTimeColumn)
public void	setCreateTimeColumn(String createTimeColumn)
protected void	setDatabaseAdaptor(DatabaseAdaptor dbadaptor)
public void	setExpiryTimeColumn(String expiryTimeColumn)
public void	setIdColumn(String idColumn)
public void	setLastAccessTimeColumn(String lastAccessTimeColumn)
public void	setLastNodeColumn(String lastNodeColumn)
public void	setLastSavedTimeColumn(String lastSavedTimeColumn)
public void	setMapColumn(String mapColumn)
public void	setMaxIntervalColumn(String maxIntervalColumn)
public void	setSchemaName(String schemaName)
public void	setTableName(String tableName)
public void	setVirtualHostColumn(String virtualHostColumn)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

_accessTimeColumn	back to summary
protected String _accessTimeColumn

_catalogName	back to summary
protected String _catalogName

_contextPathColumn	back to summary
protected String _contextPathColumn

_cookieTimeColumn	back to summary
protected String _cookieTimeColumn

_createTimeColumn	back to summary
protected String _createTimeColumn

_dbAdaptor	back to summary
protected DatabaseAdaptor _dbAdaptor

_expiryTimeColumn	back to summary
protected String _expiryTimeColumn

_idColumn	back to summary
protected String _idColumn

_lastAccessTimeColumn	back to summary
protected String _lastAccessTimeColumn

_lastNodeColumn	back to summary
protected String _lastNodeColumn

_lastSavedTimeColumn	back to summary
protected String _lastSavedTimeColumn

_mapColumn	back to summary
protected String _mapColumn

_maxIntervalColumn	back to summary
protected String _maxIntervalColumn

_schemaName	back to summary
protected String _schemaName

_tableName	back to summary
protected String _tableName

_virtualHostColumn	back to summary
protected String _virtualHostColumn

INFERRED	back to summary
public static final String INFERRED

MAX_INTERVAL_NOT_SET	back to summary
public static final int MAX_INTERVAL_NOT_SET

Constructor Detail

SessionTableSchema	back to summary
public SessionTableSchema()

Method Detail

checkNotNull	back to summary
private void checkNotNull(String s)

getAccessTimeColumn	back to summary
public String getAccessTimeColumn()

getAlterTableForMaxIntervalAsString	back to summary
public String getAlterTableForMaxIntervalAsString()

getCatalogName	back to summary
public String getCatalogName()

getCheckSessionExistsStatement	back to summary
public PreparedStatement getCheckSessionExistsStatement(Connection connection, SessionContext context) throws SQLException

getCleanOrphansStatement	back to summary
public PreparedStatement getCleanOrphansStatement(Connection connection, long timeLimit) throws Exception

getContextPathColumn	back to summary
public String getContextPathColumn()

getCookieTimeColumn	back to summary
public String getCookieTimeColumn()

getCreateIndexOverExpiryStatementAsString	back to summary
public String getCreateIndexOverExpiryStatementAsString(String indexName)

getCreateIndexOverSessionStatementAsString	back to summary
public String getCreateIndexOverSessionStatementAsString(String indexName)

getCreateStatementAsString	back to summary
public String getCreateStatementAsString()

getCreateTimeColumn	back to summary
public String getCreateTimeColumn()

getDeleteStatement	back to summary
public PreparedStatement getDeleteStatement(Connection connection, String id, SessionContext contextId) throws Exception

getExpiredSessionsStatement	back to summary
public PreparedStatement getExpiredSessionsStatement(Connection connection, String canonicalContextPath, String vhost, long expiry) throws SQLException

getExpiryTimeColumn	back to summary
public String getExpiryTimeColumn()

getIdColumn	back to summary
public String getIdColumn()

getInsertSessionStatementAsString	back to summary
public String getInsertSessionStatementAsString()

getLastAccessTimeColumn	back to summary
public String getLastAccessTimeColumn()

getLastNodeColumn	back to summary
public String getLastNodeColumn()

getLastSavedTimeColumn	back to summary
public String getLastSavedTimeColumn()

getLoadStatement	back to summary
public PreparedStatement getLoadStatement(Connection connection, String id, SessionContext contextId) throws SQLException

getMapColumn	back to summary
public String getMapColumn()

getMaxIntervalColumn	back to summary
public String getMaxIntervalColumn()

getMyExpiredSessionsStatement	back to summary
public PreparedStatement getMyExpiredSessionsStatement(Connection connection, SessionContext sessionContext, long expiry) throws SQLException

getSchemaName	back to summary
public String getSchemaName()

getSchemaTableName	back to summary
private String getSchemaTableName()

getTableName	back to summary
public String getTableName()

getUpdateSessionStatement	back to summary
public PreparedStatement getUpdateSessionStatement(Connection connection, String id, SessionContext context) throws SQLException

getUpdateStatement	back to summary
public PreparedStatement getUpdateStatement(Connection connection, String id, SessionContext contextId) throws SQLException

getVirtualHostColumn	back to summary
public String getVirtualHostColumn()

prepareTables

back to summary

public void prepareTables() throws SQLException

Set up the tables in the database

Exceptions

SQLException:: if unable to prepare tables

setAccessTimeColumn	back to summary
public void setAccessTimeColumn(String accessTimeColumn)

setCatalogName	back to summary
public void setCatalogName(String catalogName)

setContextPathColumn	back to summary
public void setContextPathColumn(String contextPathColumn)

setCookieTimeColumn	back to summary
public void setCookieTimeColumn(String cookieTimeColumn)

setCreateTimeColumn	back to summary
public void setCreateTimeColumn(String createTimeColumn)

setDatabaseAdaptor	back to summary
protected void setDatabaseAdaptor(DatabaseAdaptor dbadaptor)

setExpiryTimeColumn	back to summary
public void setExpiryTimeColumn(String expiryTimeColumn)

setIdColumn	back to summary
public void setIdColumn(String idColumn)

setLastAccessTimeColumn	back to summary
public void setLastAccessTimeColumn(String lastAccessTimeColumn)

setLastNodeColumn	back to summary
public void setLastNodeColumn(String lastNodeColumn)

setLastSavedTimeColumn	back to summary
public void setLastSavedTimeColumn(String lastSavedTimeColumn)

setMapColumn	back to summary
public void setMapColumn(String mapColumn)

setMaxIntervalColumn	back to summary
public void setMaxIntervalColumn(String maxIntervalColumn)

setSchemaName	back to summary
public void setSchemaName(String schemaName)

setTableName	back to summary
public void setTableName(String tableName)

setVirtualHostColumn	back to summary
public void setVirtualHostColumn(String virtualHostColumn)

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Class JDBCSessionDataStore

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class JDBCSessionDataStore.SessionTableSchema

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail