org.jboss.jca.adapters.jdbc.CachedPreparedStatement Maven / Gradle / Ivy
The newest version!
/*
* IronJacamar, a Java EE Connector Architecture implementation
* Copyright 2010, Red Hat Inc, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.jca.adapters.jdbc;
import java.io.InputStream;
import java.io.Reader;
import java.math.BigDecimal;
import java.sql.Array;
import java.sql.Blob;
import java.sql.Clob;
import java.sql.Connection;
import java.sql.NClob;
import java.sql.ParameterMetaData;
import java.sql.PreparedStatement;
import java.sql.Ref;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.RowId;
import java.sql.SQLException;
import java.sql.SQLWarning;
import java.sql.SQLXML;
import java.util.Calendar;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import org.jboss.logging.Logger;
/**
* Wrapper class for cached PreparedStatements. Keeps a refcount. When this refcount reaches 0,
* it will close ps.
*
* @author Bill Burke
* @author Adrian Brock
* @version $Revision: 84265 $
*/
public abstract class CachedPreparedStatement extends JBossWrapper implements PreparedStatement
{
private static final long serialVersionUID = 2085461257386274373L;
/** The logger */
protected static Logger log = Logger.getLogger(CachedPreparedStatement.class);
private PreparedStatement ps;
private AtomicBoolean cached = new AtomicBoolean(true);
private AtomicInteger inUse = new AtomicInteger(1);
private int defaultMaxFieldSize;
private int defaultMaxRows;
private int defaultQueryTimeout;
private int defaultFetchDirection;
private int defaultFetchSize;
private int currentMaxFieldSize;
private int currentMaxRows;
private int currentQueryTimeout;
private int currentFetchDirection;
private int currentFetchSize;
/**
* Constructor
* @param ps The prepared statement
* @exception SQLException Thrown if an error occurs
*/
public CachedPreparedStatement(PreparedStatement ps) throws SQLException
{
this.ps = ps;
// Remember the defaults
defaultMaxFieldSize = ps.getMaxFieldSize();
defaultMaxRows = ps.getMaxRows();
defaultQueryTimeout = ps.getQueryTimeout();
defaultFetchDirection = ps.getFetchDirection();
defaultFetchSize = ps.getFetchSize();
currentMaxFieldSize = defaultMaxFieldSize;
currentMaxRows = defaultMaxRows;
currentQueryTimeout = defaultQueryTimeout;
currentFetchDirection = defaultFetchDirection;
currentFetchSize = defaultFetchSize;
}
/**
* {@inheritDoc}
*/
public PreparedStatement getUnderlyingPreparedStatement()
{
return ps;
}
/**
* {@inheritDoc}
*/
public ResultSet executeQuery() throws SQLException
{
return ps.executeQuery();
}
/**
* {@inheritDoc}
*/
public int executeUpdate() throws SQLException
{
return ps.executeUpdate();
}
/**
* {@inheritDoc}
*/
public void setNull(int parameterIndex, int sqlType) throws SQLException
{
ps.setNull(parameterIndex, sqlType);
}
/**
* {@inheritDoc}
*/
public void setBoolean(int parameterIndex, boolean x) throws SQLException
{
ps.setBoolean(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setByte(int parameterIndex, byte x) throws SQLException
{
ps.setByte(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setShort(int parameterIndex, short x) throws SQLException
{
ps.setShort(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setInt(int parameterIndex, int x) throws SQLException
{
ps.setInt(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setLong(int parameterIndex, long x) throws SQLException
{
ps.setLong(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setFloat(int parameterIndex, float x) throws SQLException
{
ps.setFloat(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setDouble(int parameterIndex, double x) throws SQLException
{
ps.setDouble(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException
{
ps.setBigDecimal(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setString(int parameterIndex, String x) throws SQLException
{
ps.setString(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setBytes(int parameterIndex, byte x[]) throws SQLException
{
ps.setBytes(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setDate(int parameterIndex, java.sql.Date x) throws SQLException
{
ps.setDate(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setTime(int parameterIndex, java.sql.Time x) throws SQLException
{
ps.setTime(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setTimestamp(int parameterIndex, java.sql.Timestamp x) throws SQLException
{
ps.setTimestamp(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setAsciiStream(int parameterIndex, java.io.InputStream x, int length)
throws SQLException
{
ps.setAsciiStream(parameterIndex, x, length);
}
/**
* {@inheritDoc}
*/
@Deprecated
public void setUnicodeStream(int parameterIndex, java.io.InputStream x,
int length) throws SQLException
{
ps.setUnicodeStream(parameterIndex, x, length);
}
/**
* {@inheritDoc}
*/
public void setBinaryStream(int parameterIndex, java.io.InputStream x,
int length) throws SQLException
{
ps.setBinaryStream(parameterIndex, x, length);
}
/**
* {@inheritDoc}
*/
public void clearParameters() throws SQLException
{
ps.clearParameters();
}
/**
* {@inheritDoc}
*/
public void setObject(int parameterIndex, Object x, int targetSqlType, int scale)
throws SQLException
{
ps.setObject(parameterIndex, x, targetSqlType, scale);
}
/**
* {@inheritDoc}
*/
public void setObject(int parameterIndex, Object x, int targetSqlType)
throws SQLException
{
ps.setObject(parameterIndex, x, targetSqlType);
}
/**
* {@inheritDoc}
*/
public void setObject(int parameterIndex, Object x) throws SQLException
{
ps.setObject(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public boolean execute() throws SQLException
{
return ps.execute();
}
/**
* {@inheritDoc}
*/
public void addBatch() throws SQLException
{
ps.addBatch();
}
/**
* {@inheritDoc}
*/
public void setCharacterStream(int parameterIndex,
java.io.Reader reader,
int length) throws SQLException
{
ps.setCharacterStream(parameterIndex, reader, length);
}
/**
* {@inheritDoc}
*/
public void setRef(int i, Ref x) throws SQLException
{
ps.setRef(i, x);
}
/**
* {@inheritDoc}
*/
public void setBlob(int i, Blob x) throws SQLException
{
ps.setBlob(i, x);
}
/**
* {@inheritDoc}
*/
public void setClob(int i, Clob x) throws SQLException
{
ps.setClob(i, x);
}
/**
* {@inheritDoc}
*/
public void setArray(int i, Array x) throws SQLException
{
ps.setArray(i, x);
}
/**
* {@inheritDoc}
*/
public ResultSetMetaData getMetaData() throws SQLException
{
return ps.getMetaData();
}
/**
* {@inheritDoc}
*/
public void setDate(int parameterIndex, java.sql.Date x, Calendar cal)
throws SQLException
{
ps.setDate(parameterIndex, x, cal);
}
/**
* {@inheritDoc}
*/
public void setTime(int parameterIndex, java.sql.Time x, Calendar cal)
throws SQLException
{
ps.setTime(parameterIndex, x, cal);
}
/**
* {@inheritDoc}
*/
public void setTimestamp(int parameterIndex, java.sql.Timestamp x, Calendar cal)
throws SQLException
{
ps.setTimestamp(parameterIndex, x, cal);
}
/**
* {@inheritDoc}
*/
public void setNull(int paramIndex, int sqlType, String typeName)
throws SQLException
{
ps.setNull(paramIndex, sqlType, typeName);
}
/**
* {@inheritDoc}
*/
public void setURL(int parameterIndex, java.net.URL x) throws SQLException
{
ps.setURL(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public ParameterMetaData getParameterMetaData() throws SQLException
{
return ps.getParameterMetaData();
}
/**
* {@inheritDoc}
*/
public ResultSet executeQuery(String sql) throws SQLException
{
return ps.executeQuery(sql);
}
/**
* {@inheritDoc}
*/
public int executeUpdate(String sql) throws SQLException
{
return ps.executeUpdate(sql);
}
/**
* Is in use
* @return True if being used; false otherwise
*/
public boolean isInUse()
{
return inUse.get() > 0;
}
/**
* Increate inUse counter
*/
public void inUse()
{
inUse.incrementAndGet();
}
/**
* Close prepared statement
* @exception SQLException Thrown if an error occurs
*/
private void closePreparedStatement() throws SQLException
{
if (log.isTraceEnabled())
{
Throwable t = new Throwable("PreparedStatement.close() called");
t.setStackTrace(SecurityActions.getStackTrace(Thread.currentThread()));
log.trace(t.getMessage(), t);
}
ps.close();
}
/**
* Age out
* @exception SQLException Thrown if an error occurs
*/
public void agedOut() throws SQLException
{
cached.set(false);
if (inUse.get() == 0)
closePreparedStatement();
}
/**
* Close
* @exception SQLException Thrown if an error occurs
*/
public void close() throws SQLException
{
if (inUse.decrementAndGet() == 0)
{
if (!cached.get())
{
closePreparedStatement();
}
else
{
// Reset the defaults
if (defaultMaxFieldSize != currentMaxFieldSize)
{
ps.setMaxFieldSize(defaultMaxFieldSize);
currentMaxFieldSize = defaultMaxFieldSize;
}
if (defaultMaxRows != currentMaxRows)
{
ps.setMaxRows(defaultMaxRows);
currentMaxRows = defaultMaxRows;
}
if (defaultQueryTimeout != currentQueryTimeout)
{
ps.setQueryTimeout(defaultQueryTimeout);
currentQueryTimeout = defaultQueryTimeout;
}
if (defaultFetchDirection != currentFetchDirection)
{
ps.setFetchDirection(defaultFetchDirection);
currentFetchDirection = defaultFetchDirection;
}
if (defaultFetchSize != currentFetchSize)
{
ps.setFetchSize(defaultFetchSize);
currentFetchSize = defaultFetchSize;
}
ps.clearParameters();
}
}
}
/**
* {@inheritDoc}
*/
public int getMaxFieldSize() throws SQLException
{
return ps.getMaxFieldSize();
}
/**
* {@inheritDoc}
*/
public void setMaxFieldSize(int max) throws SQLException
{
ps.setMaxFieldSize(max);
currentMaxFieldSize = max;
}
/**
* {@inheritDoc}
*/
public int getMaxRows() throws SQLException
{
return ps.getMaxRows();
}
/**
* {@inheritDoc}
*/
public void setMaxRows(int max) throws SQLException
{
ps.setMaxRows(max);
currentMaxRows = max;
}
/**
* {@inheritDoc}
*/
public void setEscapeProcessing(boolean enable) throws SQLException
{
ps.setEscapeProcessing(enable);
}
/**
* {@inheritDoc}
*/
public int getQueryTimeout() throws SQLException
{
return ps.getQueryTimeout();
}
/**
* {@inheritDoc}
*/
public void setQueryTimeout(int seconds) throws SQLException
{
ps.setQueryTimeout(seconds);
currentQueryTimeout = seconds;
}
/**
* {@inheritDoc}
*/
public void cancel() throws SQLException
{
ps.cancel();
}
/**
* {@inheritDoc}
*/
public SQLWarning getWarnings() throws SQLException
{
return ps.getWarnings();
}
/**
* {@inheritDoc}
*/
public void clearWarnings() throws SQLException
{
ps.clearWarnings();
}
/**
* {@inheritDoc}
*/
public void setCursorName(String name) throws SQLException
{
ps.setCursorName(name);
}
/**
* {@inheritDoc}
*/
public boolean execute(String sql) throws SQLException
{
return ps.execute(sql);
}
/**
* {@inheritDoc}
*/
public ResultSet getResultSet() throws SQLException
{
return ps.getResultSet();
}
/**
* {@inheritDoc}
*/
public int getUpdateCount() throws SQLException
{
return ps.getUpdateCount();
}
/**
* {@inheritDoc}
*/
public boolean getMoreResults() throws SQLException
{
return ps.getMoreResults();
}
/**
* {@inheritDoc}
*/
public void setFetchDirection(int direction) throws SQLException
{
ps.setFetchDirection(direction);
currentFetchDirection = direction;
}
/**
* {@inheritDoc}
*/
public int getFetchDirection() throws SQLException
{
return ps.getFetchDirection();
}
/**
* {@inheritDoc}
*/
public void setFetchSize(int rows) throws SQLException
{
ps.setFetchSize(rows);
currentFetchSize = rows;
}
/**
* {@inheritDoc}
*/
public int getFetchSize() throws SQLException
{
return ps.getFetchSize();
}
/**
* {@inheritDoc}
*/
public int getResultSetConcurrency() throws SQLException
{
return ps.getResultSetConcurrency();
}
/**
* {@inheritDoc}
*/
public int getResultSetType() throws SQLException
{
return ps.getResultSetType();
}
/**
* {@inheritDoc}
*/
public void addBatch(String sql) throws SQLException
{
ps.addBatch(sql);
}
/**
* {@inheritDoc}
*/
public void clearBatch() throws SQLException
{
ps.clearBatch();
}
/**
* {@inheritDoc}
*/
public int[] executeBatch() throws SQLException
{
return ps.executeBatch();
}
/**
* {@inheritDoc}
*/
public Connection getConnection() throws SQLException
{
return ps.getConnection();
}
/**
* {@inheritDoc}
*/
public boolean getMoreResults(int current) throws SQLException
{
return ps.getMoreResults(current);
}
/**
* {@inheritDoc}
*/
public ResultSet getGeneratedKeys() throws SQLException
{
return ps.getGeneratedKeys();
}
/**
* {@inheritDoc}
*/
public int executeUpdate(String sql, int autoGeneratedKeys) throws SQLException
{
return ps.executeUpdate(sql, autoGeneratedKeys);
}
/**
* {@inheritDoc}
*/
public int executeUpdate(String sql, int columnIndexes[]) throws SQLException
{
return ps.executeUpdate(sql, columnIndexes);
}
/**
* {@inheritDoc}
*/
public int executeUpdate(String sql, String columnNames[]) throws SQLException
{
return ps.executeUpdate(sql, columnNames);
}
/**
* {@inheritDoc}
*/
public boolean execute(String sql, int autoGeneratedKeys) throws SQLException
{
return ps.execute(sql, autoGeneratedKeys);
}
/**
* {@inheritDoc}
*/
public boolean execute(String sql, int columnIndexes[]) throws SQLException
{
return ps.execute(sql, columnIndexes);
}
/**
* {@inheritDoc}
*/
public boolean execute(String sql, String columnNames[]) throws SQLException
{
return ps.execute(sql, columnNames);
}
/**
* {@inheritDoc}
*/
public int getResultSetHoldability() throws SQLException
{
return ps.getResultSetHoldability();
}
/**
* {@inheritDoc}
*/
public void setAsciiStream(int parameterIndex, InputStream x, long length) throws SQLException
{
ps.setAsciiStream(parameterIndex, x, length);
}
/**
* {@inheritDoc}
*/
public void setAsciiStream(int parameterIndex, InputStream x) throws SQLException
{
ps.setAsciiStream(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setBinaryStream(int parameterIndex, InputStream x, long length) throws SQLException
{
ps.setBinaryStream(parameterIndex, x, length);
}
/**
* {@inheritDoc}
*/
public void setBinaryStream(int parameterIndex, InputStream x) throws SQLException
{
ps.setBinaryStream(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setBlob(int parameterIndex, InputStream inputStream, long length) throws SQLException
{
ps.setBlob(parameterIndex, inputStream, length);
}
/**
* {@inheritDoc}
*/
public void setBlob(int parameterIndex, InputStream inputStream) throws SQLException
{
ps.setBlob(parameterIndex, inputStream);
}
/**
* {@inheritDoc}
*/
public void setCharacterStream(int parameterIndex, Reader reader, long length) throws SQLException
{
ps.setCharacterStream(parameterIndex, reader, length);
}
/**
* {@inheritDoc}
*/
public void setCharacterStream(int parameterIndex, Reader reader) throws SQLException
{
ps.setCharacterStream(parameterIndex, reader);
}
/**
* {@inheritDoc}
*/
public void setClob(int parameterIndex, Reader reader, long length) throws SQLException
{
ps.setClob(parameterIndex, reader, length);
}
/**
* {@inheritDoc}
*/
public void setClob(int parameterIndex, Reader reader) throws SQLException
{
ps.setClob(parameterIndex, reader);
}
/**
* {@inheritDoc}
*/
public void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException
{
ps.setNCharacterStream(parameterIndex, value, length);
}
/**
* {@inheritDoc}
*/
public void setNCharacterStream(int parameterIndex, Reader value) throws SQLException
{
ps.setNCharacterStream(parameterIndex, value);
}
/**
* {@inheritDoc}
*/
public void setNClob(int parameterIndex, NClob value) throws SQLException
{
ps.setNClob(parameterIndex, value);
}
/**
* {@inheritDoc}
*/
public void setNClob(int parameterIndex, Reader reader, long length) throws SQLException
{
ps.setNClob(parameterIndex, reader, length);
}
/**
* {@inheritDoc}
*/
public void setNClob(int parameterIndex, Reader reader) throws SQLException
{
ps.setNClob(parameterIndex, reader);
}
/**
* {@inheritDoc}
*/
public void setNString(int parameterIndex, String value) throws SQLException
{
ps.setNString(parameterIndex, value);
}
/**
* {@inheritDoc}
*/
public void setRowId(int parameterIndex, RowId x) throws SQLException
{
ps.setRowId(parameterIndex, x);
}
/**
* {@inheritDoc}
*/
public void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException
{
ps.setSQLXML(parameterIndex, xmlObject);
}
/**
* {@inheritDoc}
*/
public boolean isClosed() throws SQLException
{
return ps.isClosed();
}
/**
* {@inheritDoc}
*/
public boolean isPoolable() throws SQLException
{
return ps.isPoolable();
}
/**
* {@inheritDoc}
*/
public void setPoolable(boolean poolable) throws SQLException
{
ps.setPoolable(poolable);
}
/**
* {@inheritDoc}
*/
public void closeOnCompletion() throws SQLException
{
ps.closeOnCompletion();
}
/**
* {@inheritDoc}
*/
public boolean isCloseOnCompletion() throws SQLException
{
return ps.isCloseOnCompletion();
}
/**
* {@inheritDoc}
*/
protected PreparedStatement getWrappedObject() throws SQLException
{
return ps;
}
}