org.firebirdsql.pool.PooledConnectionManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation

JDBC Driver for the Firebird RDBMS

There is a newer version: 6.0.0-beta-1

/*
 * Firebird Open Source J2ee connector - jdbc driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program 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
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a CVS history command.
 *
 * All rights reserved.
 */

package org.firebirdsql.pool;

import java.sql.SQLException;

/**
 * Manager of pooled connections. Class implementing this interface allocates 
 * physical connections to the database.
 *
 * @author Roman Rokytskyy
 */
public interface PooledConnectionManager {

    /**
     * Allocate pooled connection using specified user name and password.
     * 
     * @param userName user name that will be used to access database.
     * @param password password corresponding to the specified user name.
     * 
     * @return instance of {@link javax.sql.PooledConnection}.
     * 
     * @throws SQLException if something went wrong.
     */
    PooledObject allocateConnection(Object key)
        throws SQLException;
}