    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.dbcp2.managed;
    019
    020import java.sql.Connection;
    021import java.sql.SQLException;
    022import java.util.Collection;
    023
    024import org.apache.commons.dbcp2.PoolableConnection;
    025import org.apache.commons.pool2.ObjectPool;
    026
    027/**
    028 * PoolableConnection that unregisters from TransactionRegistry on Connection real destroy.
    029 *
    030 * @see PoolableConnection
    031 * @since 2.0
    032 */
    033public class PoolableManagedConnection extends PoolableConnection {
    034    private final TransactionRegistry transactionRegistry;
    035
    036    /**
    037     * Create a PoolableManagedConnection.
    038     *
    039     * @param transactionRegistry
    040     *            transaction registry
    041     * @param conn
    042     *            underlying connection
    043     * @param pool
    044     *            connection pool
    045     */
    046    public PoolableManagedConnection(final TransactionRegistry transactionRegistry, final Connection conn,
    047            final ObjectPool<PoolableConnection> pool) {
    048        this(transactionRegistry, conn, pool, null, true);
    049    }
    050
    051    /**
    052     * Create a PoolableManagedConnection.
    053     *
    054     * @param transactionRegistry
    055     *            transaction registry
    056     * @param conn
    057     *            underlying connection
    058     * @param pool
    059     *            connection pool
    060     * @param disconnectSqlCodes
    061     *            SQL_STATE codes considered fatal disconnection errors
    062     * @param fastFailValidation
    063     *            true means fatal disconnection errors cause subsequent validations to fail immediately (no attempt to
    064     *            run query or isValid)
    065     */
    066    public PoolableManagedConnection(final TransactionRegistry transactionRegistry, final Connection conn,
    067            final ObjectPool<PoolableConnection> pool, final Collection<String> disconnectSqlCodes,
    068            final boolean fastFailValidation) {
    069        super(conn, pool, null, disconnectSqlCodes, fastFailValidation);
    070        this.transactionRegistry = transactionRegistry;
    071    }
    072
    073    /**
    074     * @return The transaction registry.
    075     * @since 2.6.0
    076     */
    077    public TransactionRegistry getTransactionRegistry() {
    078        return transactionRegistry;
    079    }
    080
    081    /**
    082     * Actually close the underlying connection.
    083     */
    084    @Override
    085    public void reallyClose() throws SQLException {
    086        try {
    087            super.reallyClose();
    088        } finally {
    089            transactionRegistry.unregisterConnection(this);
    090        }
    091    }
    092}