/* ======================================================================
The Bodington System Software License, Version 1.0
 
Copyright (c) 2001 The University of Leeds.  All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
1.  Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
 
2.  Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
 
3.  The end-user documentation included with the redistribution, if any,
must include the following acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.
 
4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.
 
5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.
 
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
=========================================================
 
This software was originally created by the University of Leeds and may contain voluntary
contributions from others.  For more information on the Bodington Open Source Project, please
see http://bodington.org/
 
====================================================================== */

package org.bodington.database;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;
import javax.sql.DataSource;

/**
 * Get database connections used by Bodington from JNDI.
 * <p>
 * Properties:
 * <table border="1">
 * <tr>
 *  <th>Property</th><th>Description</th><th>Default</th><th>Required</th>
 * </tr>
 * <tr>
 *  <td>sqldatabase.jndi.context</td>
 *  <td>The string to use as the lookup against the <code>java:/comp/env</code> context.</td>
 *  <td>jdbc/bodington</td>
 *  <td>No</td>
 * </tr>
 * </table>
 * 
 * @author buckett
 */
public class JNDIConnectionPool implements ConnectionPool
{
    Context envContext;
    private static final String DEFAULT_CONTEXT = "jdbc/bodington";
    private String context = DEFAULT_CONTEXT;
	private DataSource datasource;

    /**
     * Create a JNDI connection pool.
     * @param properties The configuration information for this pool.
     */
	public JNDIConnectionPool( Properties properties ) throws ConnectionPoolException
	{
		context = properties.getProperty("sqldatabase.jndi.context", DEFAULT_CONTEXT);
		try 
		{
			Context initContext = new InitialContext();
			envContext  = (Context)initContext.lookup("java:/comp/env");
			datasource = (DataSource)envContext.lookup(context);
		}
		catch (NamingException ne)
		{
			throw new ConnectionPoolException("Error getting the initial contexts",ne);
		}
		
	}

    /** 
     * Gets a database connection from a JNDI context.
     */
    public synchronized Connection getConnection(Object user) throws ConnectionPoolException
    {
        try
        {
        return datasource.getConnection();
        }
        catch (SQLException sqle)
        {
            throw new ConnectionPoolException("Error getting connection", sqle);
        }
    }

    /**
     * Free the database connection. In the JNDI world we just close the connection
     * and it goes back into the pool.
     * @param connection The database connection to close.
     */
    public void freeConnection(Connection connection)
        throws ConnectionPoolException
    {
        try
        {
            connection.close();
        }
        catch (SQLException sqle){}
       
    }

}