Class JDBCStore
java.lang.Object
org.apache.catalina.util.LifecycleBase
org.apache.catalina.session.StoreBase
org.apache.catalina.session.JDBCStore
- Direct Known Subclasses:
DataSourceStore
Deprecated.
Removed in Tomcat 10 and replaced by DataSourceStore with removal of legacy JDBC code
Implementation of the
Store interface that stores serialized session objects in a
database. Sessions that are saved are still subject to being expired based on inactivity.- Author:
- Bip Thelin
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringDeprecated.The connection username to use when trying to connect to the database.protected StringDeprecated.The connection URL to use when trying to connect to the database.protected StringDeprecated.Connection string to use when connecting to the DB.protected DataSourceDeprecated.DataSource to useprotected StringDeprecated.name of the JNDI resourceprotected DriverDeprecated.Instance of the JDBC Driver class we use as a connection factory.protected StringDeprecated.Driver to use.protected PreparedStatementDeprecated.Variable to hold theclear()prepared statement.protected PreparedStatementDeprecated.Variable to hold theload()prepared statement.protected PreparedStatementDeprecated.Variable to hold theremove()prepared statement.protected PreparedStatementDeprecated.Variable to hold thesave()prepared statement.protected PreparedStatementDeprecated.Variable to hold thegetSize()prepared statement.protected StringDeprecated.Column to use for /Engine/Host/Context nameprotected StringDeprecated.Data column to use.protected StringDeprecated.Id column to use.protected StringDeprecated.Last Accessed column to use.protected StringDeprecated.Max Inactive column to use.protected StringDeprecated.Table to use.protected StringDeprecated.Is Validcolumn to use.protected static final StringDeprecated.Name to register for this Store, used for logging.protected static final StringDeprecated.Name to register for the background thread.Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Deprecated.Remove all of the Sessions in this Store.protected voidclose(Connection dbConnection) Deprecated.Close the specified database connection.String[]Deprecated.Get only those keys of sessions, that are saved in the Store and are to be expired.protected ConnectionDeprecated.Check the connection associated with this store, if it'snullor closed try to reopen it.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.booleanDeprecated.getName()Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.intgetSize()Deprecated.Return an integer containing a count of all Sessions currently saved in this Store.Deprecated.Deprecated.String[]keys()Deprecated.Deprecated.Load the Session associated with the idid.protected Connectionopen()Deprecated.Open (if necessary) and return a database connection for use by this Store.protected voidrelease(Connection conn) Deprecated.Release the connection, if it is associated with a connection pool.voidDeprecated.Remove the Session with the specified session identifier from this Store, if present.voidDeprecated.Save a session to the Store.voidsetConnectionName(String connectionName) Deprecated.Set the username to use to connect to the database.voidsetConnectionPassword(String connectionPassword) Deprecated.Set the password to use to connect to the database.voidsetConnectionURL(String connectionURL) Deprecated.Set the Connection URL for this Store.voidsetDataSourceName(String dataSourceName) Deprecated.Set the JNDI name of a DataSource-factory to use for db accessvoidsetDriverName(String driverName) Deprecated.Set the driver for this Store.voidsetLocalDataSource(boolean localDataSource) Deprecated.Set totrueto cause the datasource to be looked up in the webapp JNDI Context.voidsetSessionAppCol(String sessionAppCol) Deprecated.Set the App column for the table.voidsetSessionDataCol(String sessionDataCol) Deprecated.Set the Data column for the tablevoidsetSessionIdCol(String sessionIdCol) Deprecated.Set the Id column for the table.voidsetSessionLastAccessedCol(String sessionLastAccessedCol) Deprecated.Set theLast Accessedcolumn for the tablevoidsetSessionMaxInactiveCol(String sessionMaxInactiveCol) Deprecated.Set theMax Inactivecolumn for the tablevoidsetSessionTable(String sessionTable) Deprecated.Set the table for this Store.voidsetSessionValidCol(String sessionValidCol) Deprecated.Set theIs Validcolumn for the tableprotected voidDeprecated.Start this component and implement the requirements ofLifecycleBase.startInternal().protected voidDeprecated.Stop this component and implement the requirements ofLifecycleBase.stopInternal().Methods inherited from class org.apache.catalina.session.StoreBase
addPropertyChangeListener, destroyInternal, getManager, getObjectInputStream, initInternal, processExpires, removePropertyChangeListener, setManager, toStringMethods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Field Details
-
storeName
Deprecated.Name to register for this Store, used for logging.- See Also:
-
threadName
Deprecated.Name to register for the background thread.- See Also:
-
connectionName
Deprecated.The connection username to use when trying to connect to the database. -
connectionPassword
Deprecated.The connection URL to use when trying to connect to the database. -
connectionURL
-
driver
Deprecated.Instance of the JDBC Driver class we use as a connection factory. -
driverName
-
dataSourceName
-
dataSource
-
sessionTable
-
sessionAppCol
-
sessionIdCol
-
sessionDataCol
-
sessionValidCol
-
sessionMaxInactiveCol
-
sessionLastAccessedCol
-
preparedSizeSql
Deprecated.Variable to hold thegetSize()prepared statement. -
preparedSaveSql
Deprecated.Variable to hold thesave()prepared statement. -
preparedClearSql
Deprecated.Variable to hold theclear()prepared statement. -
preparedRemoveSql
Deprecated.Variable to hold theremove()prepared statement. -
preparedLoadSql
Deprecated.Variable to hold theload()prepared statement.
-
-
Constructor Details
-
JDBCStore
public JDBCStore()Deprecated.
-
-
Method Details
-
getName
-
getThreadName
-
getStoreName
Deprecated.- Overrides:
getStoreNamein classStoreBase- Returns:
- the name for this Store, used for logging.
-
setDriverName
Deprecated.Set the driver for this Store.- Parameters:
driverName- The new driver
-
getDriverName
-
getConnectionName
Deprecated.- Returns:
- the username to use to connect to the database.
-
setConnectionName
Deprecated.Set the username to use to connect to the database.- Parameters:
connectionName- Username
-
getConnectionPassword
Deprecated.- Returns:
- the password to use to connect to the database.
-
setConnectionPassword
Deprecated.Set the password to use to connect to the database.- Parameters:
connectionPassword- User password
-
setConnectionURL
Deprecated.Set the Connection URL for this Store.- Parameters:
connectionURL- The new Connection URL
-
getConnectionURL
-
setSessionTable
Deprecated.Set the table for this Store.- Parameters:
sessionTable- The new table
-
getSessionTable
-
setSessionAppCol
Deprecated.Set the App column for the table.- Parameters:
sessionAppCol- the column name
-
getSessionAppCol
Deprecated.- Returns:
- the web application name column for the table.
-
setSessionIdCol
Deprecated.Set the Id column for the table.- Parameters:
sessionIdCol- the column name
-
getSessionIdCol
-
setSessionDataCol
Deprecated.Set the Data column for the table- Parameters:
sessionDataCol- the column name
-
getSessionDataCol
-
setSessionValidCol
Deprecated.Set theIs Validcolumn for the table- Parameters:
sessionValidCol- The column name
-
getSessionValidCol
-
setSessionMaxInactiveCol
Deprecated.Set theMax Inactivecolumn for the table- Parameters:
sessionMaxInactiveCol- The column name
-
getSessionMaxInactiveCol
-
setSessionLastAccessedCol
Deprecated.Set theLast Accessedcolumn for the table- Parameters:
sessionLastAccessedCol- The column name
-
getSessionLastAccessedCol
-
setDataSourceName
Deprecated.Set the JNDI name of a DataSource-factory to use for db access- Parameters:
dataSourceName- The JNDI name of the DataSource-factory
-
getDataSourceName
-
getLocalDataSource
public boolean getLocalDataSource()Deprecated.- Returns:
- if the datasource will be looked up in the webapp JNDI Context.
-
setLocalDataSource
public void setLocalDataSource(boolean localDataSource) Deprecated.Set totrueto cause the datasource to be looked up in the webapp JNDI Context.- Parameters:
localDataSource- the new flag value
-
expiredKeys
Deprecated.Description copied from class:StoreBaseGet only those keys of sessions, that are saved in the Store and are to be expired.- Overrides:
expiredKeysin classStoreBase- Returns:
- array of session keys, that are to be expired
- Throws:
IOException- if an input-/output error occurred
-
keys
Deprecated.- Returns:
- an array containing the session identifiers of all Sessions currently saved in this Store. If there are no such Sessions, a zero-length array is returned.
- Throws:
IOException- if an input/output error occurred
-
getSize
Deprecated.Return an integer containing a count of all Sessions currently saved in this Store. If there are no Sessions,0is returned.- Returns:
- the count of all sessions currently saved in this Store
- Throws:
IOException- if an input/output error occurred
-
load
Deprecated.Load the Session associated with the idid. If no such session is foundnullis returned.- Parameters:
id- a value of typeString- Returns:
- the stored
Session - Throws:
ClassNotFoundException- if an error occursIOException- if an input/output error occurred
-
remove
Deprecated.Remove the Session with the specified session identifier from this Store, if present. If no such Session is present, this method takes no action.- Parameters:
id- Session identifier of the Session to be removed- Throws:
IOException- if an input/output error occurs
-
clear
Deprecated.Remove all of the Sessions in this Store.- Throws:
IOException- if an input/output error occurs
-
save
Deprecated.Save a session to the Store.- Parameters:
session- the session to be stored- Throws:
IOException- if an input/output error occurs
-
getConnection
Deprecated.Check the connection associated with this store, if it'snullor closed try to reopen it. Returnsnullif the connection could not be established.- Returns:
Connectionif the connection succeeded
-
open
Deprecated.Open (if necessary) and return a database connection for use by this Store.- Returns:
- database connection ready to use
- Throws:
SQLException- if a database error occurs
-
close
Deprecated.Close the specified database connection.- Parameters:
dbConnection- The connection to be closed
-
release
Deprecated.Release the connection, if it is associated with a connection pool.- Parameters:
conn- The connection to be released
-
startInternal
Deprecated.Start this component and implement the requirements ofLifecycleBase.startInternal().- Overrides:
startInternalin classStoreBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
stopInternal
Deprecated.Stop this component and implement the requirements ofLifecycleBase.stopInternal().- Overrides:
stopInternalin classStoreBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-