We've had some issues with the background threads, expiration and stuff so I
migrated some of the common stuff into a StoreBase and had JDBCStore and FileStore
extend it and have the opportunity to implement it's own processexpires and some
other methods. The code is attatched. I've also implemented an extended table for
JDBCStore, there still remains some work on using the extended fields when checking
expiration and loading I'll have that done soon. This is what a table for JDBCStore
now should look like:
TABLE [tomcat$sessions] (
[id] [varchar] (100) NOT NULL ,
[data] [varbinary] (1000) NULL ,
[valid] [char] (1) NOT NULL ,
[maxinactive] [int] NOT NULL ,
[lastaccess] [numeric](18, 0) NULL
)
Here's how you can configure the table and column names:
<!--Store className="org.apache.catalina.session.JDBCStore" driverName="SQLDriver"
connectionURL="jdbc:protocol://server?user=;password="
sessionTable="tomcat$sessions" sessionIdCol="id" sessionDataCol="data"
sessionValidCol="valid" sessionMaxInactiveCol="maxinactive"
sessionLastAccessedCol="lastaccess" debug="99"/-->
..bip
/*
* StoreBase.java
* $Header$
* $Revision$
* $Date$
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.session;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.IOException;
import org.apache.catalina.Container;
import org.apache.catalina.Lifecycle;
import org.apache.catalina.LifecycleEvent;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.Logger;
import org.apache.catalina.Manager;
import org.apache.catalina.Store;
import org.apache.catalina.util.LifecycleSupport;
import org.apache.catalina.util.StringManager;
/**
* Abstract implementation of the Store interface to
* support most of the functionality required by a Store.
*
* @author Bip Thelin
* @version $Revision$, $Date$
*/
public abstract class StoreBase
implements Lifecycle, Runnable, Store {
// ----------------------------------------------------- Instance Variables
/**
* The descriptive information about this implementation.
*/
protected static String info = "StoreBase/1.0";
/**
* The interval (in seconds) between checks for expired sessions.
*/
protected int checkInterval = 60;
/**
* Name to register for the background thread.
*/
protected String threadName = "StoreBase";
/**
* Name to register for this Store, used for logging.
*/
protected static String storeName = "StoreBase";
/**
* The background thread.
*/
protected Thread thread = null;
/**
* The background thread completion semaphore.
*/
protected boolean threadDone = false;
/**
* The debugging detail level for this component.
*/
protected int debug = 0;
/**
* Has this component been started yet?
*/
protected boolean started = false;
/**
* The lifecycle event support for this component.
*/
protected LifecycleSupport lifecycle = new LifecycleSupport(this);
/**
* The property change support for this component.
*/
protected PropertyChangeSupport support = new PropertyChangeSupport(this);
/**
* The string manager for this package.
*/
protected StringManager sm = StringManager.getManager(Constants.Package);
/**
* The Manager with which this JDBCStore is associated.
*/
protected Manager manager;
// ------------------------------------------------------------- Properties
/**
* Return the info for this Store.
*/
public String getInfo() {
return(info);
}
/**
* Return the thread name for this Store.
*/
public String getThreadName() {
return(threadName);
}
/**
* Return the name for this Store, used for logging.
*/
public String getStoreName() {
return(storeName);
}
/**
* Set the debugging detail level for this Store.
*
* @param debug The new debugging detail level
*/
public void setDebug(int debug) {
this.debug = debug;
}
/**
* Return the debugging detail level for this Store.
*/
public int getDebug() {
return(this.debug);
}
/**
* Set the check interval (in seconds) for this Store.
*
* @param checkInterval The new check interval
*/
public void setCheckInterval(int checkInterval) {
int oldCheckInterval = this.checkInterval;
this.checkInterval = checkInterval;
support.firePropertyChange("checkInterval",
new Integer(oldCheckInterval),
new Integer(this.checkInterval));
}
/**
* Return the check interval (in seconds) for this Store.
*/
public int getCheckInterval() {
return(this.checkInterval);
}
/**
* Set the Manager with which this Store is associated.
*
* @param manager The newly associated Manager
*/
public void setManager(Manager manager) {
Manager oldManager = this.manager;
this.manager = manager;
support.firePropertyChange("manager", oldManager, this.manager);
}
/**
* Return the Manager with which the Store is associated.
*/
public Manager getManager() {
return(this.manager);
}
// --------------------------------------------------------- Public Methods
/**
* Add a lifecycle event listener to this component.
*
* @param listener The listener to add
*/
public void addLifecycleListener(LifecycleListener listener) {
lifecycle.addLifecycleListener(listener);
}
/**
* Remove a lifecycle event listener from this component.
*
* @param listener The listener to add
*/
public void removeLifecycleListener(LifecycleListener listener) {
lifecycle.removeLifecycleListener(listener);
}
/**
* Add a property change listener to this component.
*
* @param listener a value of type 'PropertyChangeListener'
*/
public void addPropertyChangeListener(PropertyChangeListener listener) {
support.addPropertyChangeListener(listener);
}
/**
* Remove a property change listener from this component.
*
* @param listener The listener to remove
*/
public void removePropertyChangeListener(PropertyChangeListener listener) {
support.removePropertyChangeListener(listener);
}
// --------------------------------------------------------- Protected Methods
/**
* Called by our background reaper thread to check if Sessions
* saved in our store are subject of being expired. If so expire
* the Session and remove it from the Store.
*
*/
protected void processExpires() {
long timeNow = System.currentTimeMillis();
String[] keys = null;
if(!started)
return;
try {
keys = keys();
} catch (IOException e) {
log (e.toString());
e.printStackTrace();
return;
}
for (int i = 0; i < keys.length; i++) {
try {
StandardSession session = (StandardSession) load(keys[i]);
if (!session.isValid())
continue;
int maxInactiveInterval = session.getMaxInactiveInterval();
if (maxInactiveInterval < 0)
continue;
int timeIdle = // Truncate, do not round up
(int) ((timeNow - session.getLastAccessedTime()) / 1000L);
if (timeIdle >= maxInactiveInterval) {
session.expire();
remove(session.getId());
}
} catch (IOException e) {
log (e.toString());
e.printStackTrace();
} catch (ClassNotFoundException e) {
log (e.toString());
e.printStackTrace();
}
}
}
/**
* Log a message on the Logger associated with our Container (if any).
*
* @param message Message to be logged
*/
protected void log(String message) {
Logger logger = null;
Container container = manager.getContainer();
if (container != null)
logger = container.getLogger();
if (logger != null) {
logger.log(getStoreName()+"[" + container.getName() + "]: "
+ message);
} else {
String containerName = null;
if (container != null)
containerName = container.getName();
System.out.println(getStoreName()+"[" + containerName
+ "]: " + message);
}
}
/**
* Called from <b>start()</b> and used for concrete Store
* implementations that need to add their own <b>start()</b> code.
*
*/
protected void storeStart() {
;
}
/**
* Called from <b>stop()</b> and used for concrete Store
* implementations that need to add their own <b>stop()</b> code.
*
*/
protected void storeStop() {
;
}
// --------------------------------------------------------- Thread Methods
/**
* The background thread that checks for session timeouts and shutdown.
*/
public void run() {
// Loop until the termination semaphore is set
while (!threadDone) {
threadSleep();
processExpires();
}
}
/**
* Prepare for the beginning of active use of the public methods of this
* component. This method should be called after <code>configure()</code>,
* and before any of the public methods of the component are utilized.
*
* @exception IllegalStateException if this component has already been
* started
* @exception LifecycleException if this component detects a fatal error
* that prevents this component from being used
*/
public void start() throws LifecycleException {
// Validate and update our current component state
if (started)
throw new LifecycleException
(sm.getString(getStoreName()+".alreadyStarted"));
lifecycle.fireLifecycleEvent(START_EVENT, null);
started = true;
// Start the background reaper thread
threadStart();
}
/**
* Gracefully terminate the active use of the public methods of this
* component. This method should be the last one called on a given
* instance of this component.
*
* @exception IllegalStateException if this component has not been started
* @exception LifecycleException if this component detects a fatal error
* that needs to be reported
*/
public void stop() throws LifecycleException {
// Validate and update our current component state
if (!started)
throw new LifecycleException
(sm.getString(getStoreName()+".notStarted"));
lifecycle.fireLifecycleEvent(STOP_EVENT, null);
started = false;
// Stop the background reaper thread
threadStop();
}
/**
* Start the background thread that will periodically check for
* session timeouts.
*/
protected void threadStart() {
if (thread != null)
return;
threadDone = false;
thread = new Thread(this, getThreadName());
thread.setDaemon(true);
thread.start();
}
/**
* Sleep for the duration specified by the <code>checkInterval</code>
* property.
*/
protected void threadSleep() {
try {
Thread.sleep(checkInterval * 1000L);
} catch (InterruptedException e) {
;
}
}
/**
* Stop the background thread that is periodically checking for
* session timeouts.
*/
protected void threadStop() {
if (thread == null)
return;
threadDone = true;
thread.interrupt();
try {
thread.join();
} catch (InterruptedException e) {
;
}
thread = null;
}
}
/*
* JDBCStore.java
* $Header$
* $Revision$
* $Date$
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.session;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamClass;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import org.apache.catalina.Container;
import org.apache.catalina.Loader;
import org.apache.catalina.Session;
import org.apache.catalina.Store;
import org.apache.catalina.util.CustomObjectInputStream;
/**
* Implementation of the <code>Store</code> 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
* @version $Revision$, $Date$
*/
public class JDBCStore
extends StoreBase implements Store {
/**
* The descriptive information about this implementation.
*/
protected static String info = "JDBCStore/1.0";
/**
* Name to register for this Store, used for logging.
*/
protected static String storeName = "JDBCStore";
/**
* Name to register for the background thread.
*/
protected String threadName = "JDBCStore";
/**
* Connection string to use when connecting to the DB.
*/
protected String connString = null;
/**
* The database connection.
*/
private Connection conn = null;
/**
* Driver to use.
*/
protected String driverName = null;
// ------------------------------------------------------------- Table & cols
/**
* Table to use.
*/
protected String sessionTable = "tomcat$sessions";
/**
* Id column to use.
*/
protected String sessionIdCol = "id";
/**
* Data column to use.
*/
protected String sessionDataCol = "data";
/**
* Is Valid column to use.
*/
protected String sessionValidCol = "valid";
/**
* Max Inactive column to use.
*/
protected String sessionMaxInactiveCol = "maxinactive";
/**
* Last Accessed column to use.
*/
protected String sessionLastAccessedCol = "lastaccess";
// ------------------------------------------------------------- SQL Variables
/**
* Variable to hold the <code>getSize()</code> prepared statement.
*/
protected PreparedStatement preparedSizeSql = null;
/**
* Variable to hold the <code>keys()</code> prepared statement.
*/
protected PreparedStatement preparedKeysSql = null;
/**
* Variable to hold the <code>save()</code> prepared statement.
*/
protected PreparedStatement preparedSaveSql = null;
/**
* Variable to hold the <code>clear()</code> prepared statement.
*/
protected PreparedStatement preparedClearSql = null;
/**
* Variable to hold the <code>remove()</code> prepared statement.
*/
protected PreparedStatement preparedRemoveSql = null;
/**
* Variable to hold the <code>load()</code> prepared statement.
*/
protected PreparedStatement preparedLoadSql = null;
// ------------------------------------------------------------- Properties
/**
* Return the info for this Store.
*/
public String getInfo() {
return(info);
}
/**
* Return the thread name for this Store.
*/
public String getThreadName() {
return(threadName);
}
/**
* Return the name for this Store, used for logging.
*/
public String getStoreName() {
return(storeName);
}
/**
* Set the driver for this Store.
*
* @param driverName The new driver
*/
public void setDriverName(String driverName) {
String oldDriverName = this.driverName;
this.driverName = driverName;
support.firePropertyChange("driverName",
oldDriverName,
this.driverName);
this.driverName = driverName;
}
/**
* Return the driver for this Store.
*/
public String getDriverName() {
return(this.driverName);
}
/**
* Set the Connection URL for this Store.
*
* @param connectionURL The new Connection URL
*/
public void setConnectionURL(String connectionURL) {
String oldConnString = this.connString;
this.connString = connectionURL;
support.firePropertyChange("connString",
oldConnString,
this.connString);
}
/**
* Return the Connection URL for this Store.
*/
public String getConnectionURL() {
return(this.connString);
}
/**
* Set the table for this Store.
*
* @param sessionTable The new table
*/
public void setSessionTable(String sessionTable) {
String oldSessionTable = this.sessionTable;
this.sessionTable = sessionTable;
support.firePropertyChange("sessionTable",
oldSessionTable,
this.sessionTable);
}
/**
* Return the table for this Store.
*/
public String getSessionTable() {
return(this.sessionTable);
}
/**
* Set the Id column for the table.
*
* @param sessionIdCol the column name
*/
public void setSessionIdCol(String sessionIdCol) {
String oldSessionIdCol = this.sessionIdCol;
this.sessionIdCol = sessionIdCol;
support.firePropertyChange("sessionIdCol",
oldSessionIdCol,
this.sessionIdCol);
}
/**
* Return the Id column for the table.
*/
public String getSessionIdCol() {
return(this.sessionIdCol);
}
/**
* Set the Data column for the table
*
* @param sessionDataCol the column name
*/
public void setSessionDataCol(String sessionDataCol) {
String oldSessionDataCol = this.sessionDataCol;
this.sessionDataCol = sessionDataCol;
support.firePropertyChange("sessionDataCol",
oldSessionDataCol,
this.sessionDataCol);
}
/**
* Return the data column for the table
*/
public String getSessionDataCol() {
return(this.sessionDataCol);
}
/**
* Set the Is Valid column for the table
*
* @param sessionValidCol The column name
*/
public void setSessionValidCol(String sessionValidCol) {
String oldSessionValidCol = this.sessionValidCol;
this.sessionValidCol = sessionValidCol;
support.firePropertyChange("sessionValidCol",
oldSessionValidCol,
this.sessionValidCol);
}
/**
* Return the Is Valid column
*/
public String getSessionValidCol() {
return(this.sessionValidCol);
}
/**
* Set the Max Inactive column for the table
*
* @param sessionMaxInactiveCol The column name
*/
public void setSessionMaxInactiveCol(String sessionMaxInactiveCol) {
String oldSessionMaxInactiveCol = this.sessionMaxInactiveCol;
this.sessionMaxInactiveCol = sessionMaxInactiveCol;
support.firePropertyChange("sessionMaxInactiveCol",
oldSessionMaxInactiveCol,
this.sessionMaxInactiveCol);
}
/**
* Return the Max Inactive column
*/
public String getSessionMaxInactiveCol() {
return(this.sessionMaxInactiveCol);
}
/**
* Set the Last Accessed column for the table
*
* @param sessionLastAccessedCol The column name
*/
public void setSessionLastAccessedCol(String sessionLastAccessedCol) {
String oldSessionLastAccessedCol = this.sessionLastAccessedCol;
this.sessionLastAccessedCol = sessionLastAccessedCol;
support.firePropertyChange("sessionLastAccessedCol",
oldSessionLastAccessedCol,
this.sessionLastAccessedCol);
}
/**
* Return the Last Accessed column
*/
public String getSessionLastAccessedCol() {
return(this.sessionLastAccessedCol);
}
// --------------------------------------------------------- Public Methods
/**
* Return 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.
*
* @exception IOException if an input/output error occurred
*/
public String[] keys() throws IOException {
String keysSql =
"SELECT c.size, s."+sessionIdCol+
" FROM "+sessionTable+" s, "+
"(SELECT COUNT("+sessionIdCol+
") AS size FROM "+sessionTable+") c";
Connection _conn = getConnection();
ResultSet rst = null;
String keys[] = null;
int i;
if(_conn == null)
return(new String[0]);
try {
if(preparedKeysSql == null)
preparedKeysSql = _conn.prepareStatement(keysSql);
rst = preparedKeysSql.executeQuery();
if (rst != null && rst.next()) {
keys = new String[rst.getInt(1)];
keys[0] = rst.getString(2);
i=1;
while(rst.next())
keys[i++] = rst.getString(2);
} else {
keys = new String[0];
}
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} finally {
try {
if(rst != null)
rst.close();
} catch(SQLException e) {
;
}
release(_conn);
_conn = null;
}
return(keys);
}
/**
* Return an integer containing a count of all Sessions
* currently saved in this Store. If there are no Sessions,
* <code>0</code> is returned.
*
* @exception IOException if an input/output error occurred
*/
public int getSize() throws IOException {
int size = 0;
String sizeSql = "SELECT COUNT("+sessionIdCol+
") FROM ".concat(sessionTable);
Connection _conn = getConnection();
ResultSet rst = null;
if(_conn == null)
return(size);
try {
if(preparedSizeSql == null)
preparedSizeSql = _conn.prepareStatement(sizeSql);
rst = preparedSizeSql.executeQuery();
if (rst.next())
size = rst.getInt(1);
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} finally {
try {
if(rst != null)
rst.close();
} catch(SQLException e) {
;
}
release(_conn);
_conn = null;
}
return(size);
}
/**
* Load the Session associated with the id <code>id</code>.
* If no such session is found <code>null</code> is returned.
*
* @param id a value of type <code>String</code>
* @return the stored <code>Session</code>
* @exception ClassNotFoundException if an error occurs
* @exception IOException if an input/output error occurred
*/
public Session load(String id)
throws ClassNotFoundException, IOException {
ResultSet rst = null;
Connection _conn = getConnection();
StandardSession _session = null;
Loader loader = null;
ClassLoader classLoader = null;
ObjectInputStream ois = null;
BufferedInputStream bis = null;
Container container = manager.getContainer();
String loadSql = "SELECT "+sessionIdCol+
", "+sessionDataCol+" FROM "+sessionTable+
" WHERE "+sessionIdCol+" = ?";
if(_conn == null)
return(null);
try {
if(preparedLoadSql == null)
preparedLoadSql = _conn.prepareStatement(loadSql);
preparedLoadSql.setString(1, id);
rst = preparedLoadSql.executeQuery();
if (rst.next()) {
bis = new BufferedInputStream(rst.getBinaryStream(2));
if (container != null)
loader = container.getLoader();
if (loader != null)
classLoader = loader.getClassLoader();
if (classLoader != null)
ois = new CustomObjectInputStream(bis,
classLoader);
else
ois = new ObjectInputStream(bis);
} else if (debug > 0) {
log(getStoreName()+": No persisted data object found");
}
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} finally {
try {
if(rst != null)
rst.close();
} catch(SQLException e) {
;
}
release(_conn);
_conn = null;
}
try {
_session = (StandardSession) manager.createSession();
_session.readObjectData(ois);
_session.setManager(manager);
} finally {
if (ois != null) {
try {
ois.close();
bis = null;
} catch (IOException e) {
;
}
}
}
if (debug > 0)
log(sm.getString(getStoreName()+".loading",
id, sessionTable));
return(_session);
}
/**
* Remove the Session with the specified session identifier from
* this Store, if present. If no such Session is present, this method
* takes no action.
*
* @param id Session identifier of the Session to be removed
*
* @exception IOException if an input/output error occurs
*/
public void remove(String id) throws IOException {
Connection _conn = getConnection();
String removeSql = "DELETE FROM "+sessionTable+" WHERE "+
sessionIdCol+" = ?";
if(_conn == null)
return;
try {
if(preparedRemoveSql == null)
preparedRemoveSql = _conn.prepareStatement(removeSql);
preparedRemoveSql.setString(1, id);
preparedRemoveSql.execute();
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} finally {
release(_conn);
_conn = null;
}
if (debug > 0)
log(sm.getString(getStoreName()+".removing", id, sessionTable));
}
/**
* Remove all of the Sessions in this Store.
*
* @exception IOException if an input/output error occurs
*/
public void clear() throws IOException {
Connection _conn = getConnection();
String clearSql = "DELETE FROM ".concat(sessionTable);
if(_conn == null)
return;
try {
if(preparedClearSql == null)
preparedClearSql = _conn.prepareStatement(clearSql);
preparedClearSql.execute();
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} finally {
release(_conn);
_conn = null;
}
}
/**
* Save a session to the Store.
*
* @param session the session to be stored
* @exception IOException if an input/output error occurs
*/
public void save(Session session) throws IOException {
String saveSql = "INSERT INTO "+sessionTable+" ("+
sessionIdCol+", "+
sessionDataCol+", "+
sessionValidCol+", "+
sessionMaxInactiveCol+", "+
sessionLastAccessedCol+") VALUES (?, ?, ?, ?, ?)";
Connection _conn = getConnection();
ObjectOutputStream oos = null;
ByteArrayOutputStream bos = null;
ByteArrayInputStream bis = null;
InputStream in = null;
if(_conn == null)
return;
// If sessions already exist in DB, remove and insert again.
// TODO:
// * Check if ID exists in database and if so use UPDATE.
remove(session.getId());
try {
bos = new ByteArrayOutputStream();
oos = new ObjectOutputStream(new BufferedOutputStream(bos));
((StandardSession)session).writeObjectData(oos);
oos.close();
byte[] obs = bos.toByteArray();
int size = obs.length;
bis = new ByteArrayInputStream(obs, 0, size);
in = new BufferedInputStream(bis, size);
if(preparedSaveSql == null)
preparedSaveSql = _conn.prepareStatement(saveSql);
preparedSaveSql.setString(1, session.getId());
preparedSaveSql.setBinaryStream(2, in, size);
preparedSaveSql.setString(3, session.isValid()?"1":"0");
preparedSaveSql.setInt(4, session.getMaxInactiveInterval());
preparedSaveSql.setLong(5, session.getLastAccessedTime());
preparedSaveSql.execute();
} catch(SQLException e) {
log(sm.getString(getStoreName()+".SQLException", e));
} catch (IOException e) {
;
} finally {
if(bis != null)
bis.close();
if(in != null)
in.close();
bis = null;
bos = null;
oos = null;
in = null;
release(_conn);
_conn = null;
}
if (debug > 0)
log(sm.getString(getStoreName()+".saving",
session.getId(), sessionTable));
}
// --------------------------------------------------------- Protected Methods
/**
* Check the connection associated with this store, if it's
* <code>null</code> or closed try to reopen it.
* Returns <code>null</code> if the connection could not be established.
*
* @return <code>Connection</code> if the connection suceeded
*/
protected Connection getConnection(){
try {
if(conn == null || conn.isClosed()) {
Class.forName(driverName);
log(sm.getString(getStoreName()+".checkConnectionDBClosed"));
conn = DriverManager.getConnection(connString);
conn.setAutoCommit(true);
if(conn == null || conn.isClosed())
log(sm.getString(getStoreName()+".checkConnectionDBReOpenFail"));
}
} catch (SQLException ex){
log(sm.getString(getStoreName()+".checkConnectionSQLException",
ex.toString()));
} catch (ClassNotFoundException ex) {
log(sm.getString(getStoreName()+".checkConnectionClassNotFoundException",
ex.toString()));
}
return conn;
}
/**
* Release the connection, not needed here since the
* connection is not associated with a connection pool.
*
* @param conn The connection to be released
*/
protected void release(Connection conn) {
;
}
/**
* Called once when this Store is first started.
*/
public void storeStart() {
// Open connection to the database
this.conn = getConnection();
}
/**
* Gracefully terminate everything associated with our db.
* Called once when this Store is stoping.
*
*/
protected void storeStop() {
// Close and release everything associated with our db.
if(conn != null) {
try {
conn.commit();
} catch (SQLException e) {
;
}
try {
preparedSizeSql.close();
} catch (SQLException e) {
;
}
try {
preparedKeysSql.close();
} catch (SQLException e) {
;
}
try {
preparedSaveSql.close();
} catch (SQLException e) {
;
}
try {
preparedClearSql.close();
} catch (SQLException e) {
;
}
try {
preparedRemoveSql.close();
} catch (SQLException e) {
;
}
try {
preparedLoadSql.close();
} catch (SQLException e) {
;
}
try {
conn.close();
} catch (SQLException e) {
;
}
this.preparedSizeSql = null;
this.preparedKeysSql = null;
this.preparedSaveSql = null;
this.preparedClearSql = null;
this.preparedRemoveSql = null;
this.preparedLoadSql = null;
this.conn = null;
}
}
}
/*
* $Header:
/home/cvspublic/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/session/FileStore.java,v
1.4 2001/04/14 10:56:29 kief Exp $
* $Revision: 1.4 $
* $Date: 2001/04/14 10:56:29 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.session;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamClass;
import java.io.Serializable;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Vector;
import javax.servlet.ServletContext;
import org.apache.catalina.Context;
import org.apache.catalina.Globals;
import org.apache.catalina.Loader;
import org.apache.catalina.Session;
import org.apache.catalina.Store;
import org.apache.catalina.Container;
import org.apache.catalina.util.CustomObjectInputStream;
/**
* Concrete implementation of the <b>Store</b> interface that utilizes
* a file per saved Session in a configured directory. Sessions that are
* saved are still subject to being expired based on inactivity.
*
* @author Craig R. McClanahan
* @version $Revision: 1.4 $ $Date: 2001/04/14 10:56:29 $
*/
public final class FileStore
extends StoreBase implements Store {
// ----------------------------------------------------- Constants
/**
* The extension to use for serialized session filenames.
*/
private static final String FILE_EXT = ".session";
// ----------------------------------------------------- Instance Variables
/**
* The pathname of the directory in which Sessions are stored.
* Relative to the temp directory for the web application.
*/
private String directory = ".";
/**
* A File representing the directory in which Sessions are stored.
*/
private File directoryFile = null;
/**
* The descriptive information about this implementation.
*/
private static final String info = "FileStore/1.0";
/**
* Name to register for this Store, used for logging.
*/
private static final String storeName = "fileStore";
/**
* Name to register for the background thread.
*/
private static final String threadName = "FileStore";
// ------------------------------------------------------------- Properties
/**
* Return the directory path for this Store.
*/
public String getDirectory() {
return (directory);
}
/**
* Set the directory path for this Store.
*
* @param path The new directory path
*/
public void setDirectory(String path) {
String oldDirectory = this.directory;
this.directory = path;
this.directoryFile = null;
support.firePropertyChange("directory", oldDirectory,
this.directory);
}
/**
* Return descriptive information about this Store implementation and
* the corresponding version number, in the format
* <code><description>/<version></code>.
*/
public String getInfo() {
return (info);
}
/**
* Return the thread name for this Store.
*/
public String getThreadName() {
return(threadName);
}
/**
* Return the name for this Store, used for logging.
*/
public String getStoreName() {
return(storeName);
}
/**
* Return the number of Sessions present in this Store.
*
* @exception IOException if an input/output error occurs
*/
public int getSize() throws IOException {
String[] files = getDirectoryFile().list();
// Figure out which files are sessions
int keycount = 0;
for (int i = 0; i < files.length; i++) {
if (files[i].endsWith(FILE_EXT))
keycount++;
}
return (keycount);
}
// --------------------------------------------------------- Public Methods
/**
* Return 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.
*
* @exception IOException if an input/output error occurred
*/
public String[] keys() throws IOException {
String[] files = getDirectoryFile().list();
// Figure out which files contain sessions
int keycount = 0;
for (int i = 0; i < files.length; i++) {
if (files[i].endsWith(FILE_EXT))
keycount++;
else
files[i] = null;
}
// Get keys from relevant filenames.
String[] keys = new String[keycount];
if (keycount > 0) {
keycount = 0;
for (int i = 0; i < files.length; i++) {
if (files[i] != null) {
keys[keycount] = files[i].substring (0, files[i].lastIndexOf('.'));
keycount++;
}
}
}
return (keys);
}
/**
* Load and return the Session associated with the specified session
* identifier from this Store, without removing it. If there is no
* such stored Session, return <code>null</code>.
*
* @param id Session identifier of the session to load
*
* @exception ClassNotFoundException if a deserialization error occurs
* @exception IOException if an input/output error occurs
*/
public Session load(String id)
throws ClassNotFoundException, IOException {
// Open an input stream to the specified pathname, if any
File file = file(id);
if (file == null)
return (null);
if (debug >= 1)
log(sm.getString(getStoreName()+".loading",
id, file.getAbsolutePath()));
FileInputStream fis = null;
ObjectInputStream ois = null;
Loader loader = null;
ClassLoader classLoader = null;
try {
fis = new FileInputStream(file.getAbsolutePath());
BufferedInputStream bis = new BufferedInputStream(fis);
Container container = manager.getContainer();
if (container != null)
loader = container.getLoader();
if (loader != null)
classLoader = loader.getClassLoader();
if (classLoader != null)
ois = new CustomObjectInputStream(bis, classLoader);
else
ois = new ObjectInputStream(bis);
} catch (FileNotFoundException e) {
if (debug >= 1)
log("No persisted data file found");
return (null);
} catch (IOException e) {
if (ois != null) {
try {
ois.close();
} catch (IOException f) {
;
}
ois = null;
}
throw e;
}
try {
StandardSession session = (StandardSession) manager.createSession();
session.readObjectData(ois);
session.setManager(manager);
return (session);
} finally {
// Close the input stream
if (ois != null) {
try {
ois.close();
} catch (IOException f) {
;
}
}
}
}
/**
* Remove the Session with the specified session identifier from
* this Store, if present. If no such Session is present, this method
* takes no action.
*
* @param id Session identifier of the Session to be removed
*
* @exception IOException if an input/output error occurs
*/
public void remove(String id) throws IOException {
// Open an input stream to the specified pathname, if any
File file = file(id);
if (file == null)
return;
if (debug >= 1)
log(sm.getString(getStoreName()+".removing",
id, file.getAbsolutePath()));
file.delete();
}
/**
* Remove all of the Sessions in this Store.
*
* @exception IOException if an input/output error occurs
*/
public void clear()
throws IOException {
String[] keys = keys();
for (int i = 0; i < keys.length; i++) {
remove(keys[i]);
}
}
/**
* Save the specified Session into this Store. Any previously saved
* information for the associated session identifier is replaced.
*
* @param session Session to be saved
*
* @exception IOException if an input/output error occurs
*/
public void save(Session session) throws IOException {
// Open an output stream to the specified pathname, if any
File file = file(session.getId());
if (file == null)
return;
if (debug >= 1)
log(sm.getString(getStoreName()+".saving",
session.getId(), file.getAbsolutePath()));
FileOutputStream fos = null;
ObjectOutputStream oos = null;
try {
fos = new FileOutputStream(file.getAbsolutePath());
oos = new ObjectOutputStream(new BufferedOutputStream(fos));
} catch (IOException e) {
if (oos != null) {
try {
oos.close();
} catch (IOException f) {
;
}
}
throw e;
}
try {
((StandardSession)session).writeObjectData(oos);
} finally {
oos.close();
}
}
// -------------------------------------------------------- Private Methods
/**
* Return a File object representing the pathname to our
* session persistence file, if any.
*
* @param id The ID of the Session to be retrieved. This is
* used in the file naming.
*/
private File file(String id) {
if (directory == null)
return (null);
String pathname = directory + "/" + id + FILE_EXT;
File file = new File(pathname);
if (!file.isAbsolute()) {
File tempdir = getDirectoryFile();
if (tempdir != null)
file = new File(tempdir, pathname);
}
return (file);
}
/**
* Return a File object for the directory property.
*/
private File getDirectoryFile() {
if (directoryFile == null) {
Container container = manager.getContainer();
if (container instanceof Context) {
ServletContext servletContext =
((Context) container).getServletContext();
directoryFile = (File)
servletContext.getAttribute(Globals.WORK_DIR_ATTR);
} else {
throw new IllegalArgumentException("directory not set, I can't
work with this Container");
}
}
return directoryFile;
}
}
