com.aionemu.commons.database.PoolableConnectionFactoryAE.java Source code

Introduction

Here is the source code for com.aionemu.commons.database.PoolableConnectionFactoryAE.java

Source

/**
 * This file is part of Aion X Emu <aionxemu.com>
 *
 *  This is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser Public License as published by
 *  the Free Software Foundation, either version 3 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 Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser Public License
 *  along with this software.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.aionemu.commons.database;

import org.apache.commons.dbcp.ConnectionFactory;
import org.apache.commons.dbcp.PoolableConnectionFactory;
import org.apache.commons.pool.KeyedObjectPool;
import org.apache.commons.pool.KeyedObjectPoolFactory;
import org.apache.commons.pool.ObjectPool;

import java.sql.Connection;
import java.sql.SQLException;

/**
 * Implementation of PoolableConnectionFactory that Override validateConnection(Connection conn) for testing if
 * connection is still valid, but instead doing manual query [like it is in default implementation] we will use
 * Connection.isValid(timeout) from 1.6 [MySql implementation is just doing ping to Sql server]
 *
 * @author -Nemesiss-
 */
public class PoolableConnectionFactoryAE extends PoolableConnectionFactory {
    /**
     * Validation time out - how much seconds driver should wait for response from server. 0 - indicates there are no
     * timeout -1 - indicates that validation should not be used.
     */
    private final int validationTimeout;

    /**
     * Create a new <tt>PoolableConnectionFactoryAE</tt>.
     *
     * @param connFactory       the {@link ConnectionFactory} from which to obtain base {@link Connection}s
     * @param pool              the {@link ObjectPool} in which to pool those {@link Connection}s
     * @param stmtPoolFactory   the {@link KeyedObjectPoolFactory} to use to create {@link KeyedObjectPool}s for pooling
     *                          {@link java.sql.PreparedStatement}s, or <tt>null</tt> to disable {@link java.sql.PreparedStatement}
     *                          pooling
     * @param validationTimeout a timeout value in seconds used to {@link #validateObject validate} {@link Connection}s. Value of
     *                          <tt>0</tt> means no timeout. Using <tt>-1</tt> turns off validation.
     * @param defaultReadOnly   the default "read only" setting for borrowed {@link Connection}s
     * @param defaultAutoCommit the default "auto commit" setting for returned {@link Connection}s
     */
    public PoolableConnectionFactoryAE(ConnectionFactory connFactory, ObjectPool pool,
            KeyedObjectPoolFactory stmtPoolFactory, int validationTimeout, boolean defaultReadOnly,
            boolean defaultAutoCommit) {
        super(connFactory, pool, stmtPoolFactory, null, defaultReadOnly, defaultAutoCommit);
        this.validationTimeout = validationTimeout;
    }

    /**
     * Validate connection by checking if connection is not closed and is still valid. throws SQLException if connection
     * is invalid.
     */
    @Override
    public void validateConnection(Connection conn) throws SQLException {
        if (conn.isClosed())
            throw new SQLException("validateConnection: connection closed");
        if (validationTimeout >= 0 && !conn.isValid(validationTimeout))
            throw new SQLException("validateConnection: connection invalid");
    }
}