PoolablePreparedStatement.java
- /*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- package org.apache.tomcat.dbcp.dbcp2;
- import java.sql.PreparedStatement;
- import java.sql.SQLException;
- import org.apache.tomcat.dbcp.pool2.KeyedObjectPool;
- /**
- * A {@link DelegatingPreparedStatement} that cooperates with {@link PoolingConnection} to implement a pool of
- * {@link PreparedStatement}s.
- * <p>
- * My {@link #close} method returns me to my containing pool. (See {@link PoolingConnection}.)
- * </p>
- *
- * @param <K>
- * the key type
- *
- * @see PoolingConnection
- * @since 2.0
- */
- public class PoolablePreparedStatement<K> extends DelegatingPreparedStatement {
- /**
- * The {@link KeyedObjectPool} from which I was obtained.
- */
- private final KeyedObjectPool<K, PoolablePreparedStatement<K>> pool;
- /**
- * My "key" as used by {@link KeyedObjectPool}.
- */
- private final K key;
- private volatile boolean batchAdded;
- /**
- * Constructs a new instance.
- *
- * @param stmt
- * my underlying {@link PreparedStatement}
- * @param key
- * my key as used by {@link KeyedObjectPool}
- * @param pool
- * the {@link KeyedObjectPool} from which I was obtained.
- * @param conn
- * the {@link java.sql.Connection Connection} from which I was created
- */
- public PoolablePreparedStatement(final PreparedStatement stmt, final K key,
- final KeyedObjectPool<K, PoolablePreparedStatement<K>> pool, final DelegatingConnection<?> conn) {
- super(conn, stmt);
- this.pool = pool;
- this.key = key;
- // Remove from trace now because this statement will be
- // added by the activate method.
- removeThisTrace(conn);
- }
- @Override
- public void activate() throws SQLException {
- setClosedInternal(false);
- add(getConnectionInternal(), this);
- super.activate();
- }
- /**
- * Add batch.
- */
- @Override
- public void addBatch() throws SQLException {
- super.addBatch();
- batchAdded = true;
- }
- /**
- * Clear Batch.
- */
- @Override
- public void clearBatch() throws SQLException {
- batchAdded = false;
- super.clearBatch();
- }
- /**
- * Return me to my pool.
- */
- @Override
- public void close() throws SQLException {
- // calling close twice should have no effect
- if (!isClosed()) {
- try {
- pool.returnObject(key, this);
- } catch (final SQLException | RuntimeException e) {
- throw e;
- } catch (final Exception e) {
- throw new SQLException("Cannot close preparedstatement (return to pool failed)", e);
- }
- }
- }
- /**
- * Package-protected for tests.
- *
- * @return The key.
- */
- K getKey() {
- return key;
- }
- @Override
- public void passivate() throws SQLException {
- // DBCP-372. clearBatch with throw an exception if called when the
- // connection is marked as closed.
- if (batchAdded) {
- clearBatch();
- }
- prepareToReturn();
- }
- }