/*
 * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.jndi.ldap.pool;
import javax.naming.NamingException;

/**
 * Represents a factory that creates PooledConnection.
 *
 * The user of the connection pool should provide an implementation of this
 * interface and pass it to the Pool.getPooledConnection() method.
 * The implementation of the factory should contain all the information
 * necessary to create a PooledConnection.
 *
 * @author Rosanna Lee
 */
public interface PooledConnectionFactory {
    /**
     * Creates a pooled connection.
     * @param pcb callback responsible for removing and releasing the pooled
     * connection from the pool.
     */
    public abstract PooledConnection createPooledConnection(PoolCallback pcb)
        throws NamingException;

    /**
     * Creates a pooled connection.
     * @param pcb callback responsible for removing and releasing the pooled
     * connection from the pool.
     * @param timeout the connection timeout
     */
    public abstract PooledConnection createPooledConnection(PoolCallback pcb, long timeout)
        throws NamingException;
};
