    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    /**
    038     * Create a PoolableManagedConnection.
    039     *
    040     * @param transactionRegistry transaction registry
    041     * @param conn underlying connection
    042     * @param pool connection pool
    043     */
    044    public PoolableManagedConnection(final TransactionRegistry transactionRegistry,
    045            final Connection conn, final ObjectPool<PoolableConnection> pool) {
    046        this(transactionRegistry, conn, pool, null, false);
    047    }
    048
    049
    050    /**
    051     * Create a PoolableManagedConnection.
    052     *
    053     * @param transactionRegistry transaction registry
    054     * @param conn underlying connection
    055     * @param pool connection pool
    056     * @param disconnectSqlCodes SQL_STATE codes considered fatal disconnection errors
    057     * @param fastFailValidation true means fatal disconnection errors cause subsequent
    058     *        validations to fail immediately (no attempt to run query or isValid)
    059     */
    060    public PoolableManagedConnection(final TransactionRegistry transactionRegistry,
    061            final Connection conn, final ObjectPool<PoolableConnection> pool,
    062            final Collection<String> disconnectSqlCodes,
    063            final boolean fastFailValidation) {
    064        super(conn, pool, null, disconnectSqlCodes, fastFailValidation);
    065        this.transactionRegistry = transactionRegistry;
    066    }
    067
    068
    069    /**
    070     * Actually close the underlying connection.
    071     */
    072    @Override
    073    public void reallyClose() throws SQLException {
    074        try {
    075            super.reallyClose();
    076        } finally {
    077            transactionRegistry.unregisterConnection(this);
    078        }
    079    }
    080}