/**
 * Copyright (c) 2014, the Railo Company Ltd.
 * Copyright (c) 2015, Lucee Assosication Switzerland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either 
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public 
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 * 
 */
package lucee.runtime.db;

import lucee.runtime.PageContext;
import lucee.runtime.exp.PageException;

public interface DataSourceManager {

	/**
	 * return a database connection matching to datsource name
	 * 
	 * @param datasource datasource whished
	 * @param user username to datasource
	 * @param pass password to datasource
	 * @return return a Db Connectio9n Object
	 * @throws PageException
	 * @deprecated use instead
	 *             <code>getConnection(PageContext pc,DataSource ds, String user, String pass)</code>
	 */
	@Deprecated
	public DatasourceConnection getConnection(PageContext pc,
			String datasource, String user, String pass) throws PageException;

	/**
	 * return a database connection matching to datsource name
	 * 
	 * @param ds datasource whished
	 * @param user username to datasource
	 * @param pass password to datasource
	 * @return return a Db Connectio9n Object
	 * @throws PageException
	 */
	public DatasourceConnection getConnection(PageContext pc, DataSource ds,
			String user, String pass) throws PageException;

	public abstract void releaseConnection(PageContext pc,
			DatasourceConnection dc) throws PageException;

	/**
	 * set state of transaction to begin
	 */
	public abstract void begin();

	/**
	 * set state of transaction to begin
	 * 
	 * @param isolation isolation level of the transaction
	 */
	public abstract void begin(String isolation);

	/**
	 * set state of transaction to begin
	 * 
	 * @param isolation isolation level of the transaction
	 */
	public abstract void begin(int isolation);

	/**
	 * rollback hanging transaction
	 * 
	 * @throws PageException
	 */
	public abstract void rollback() throws PageException;

	public abstract void savepoint() throws PageException;

	/**
	 * commit hanging transaction
	 * 
	 * @throws PageException
	 */
	public abstract void commit() throws PageException;

	/**
	 * @return return if manager is in autocommit mode or not
	 */
	public abstract boolean isAutoCommit();

	/**
	 * ends the manual commit state
	 */
	public abstract void end();

	/**
	 * @deprecated use instead <code>remove(DataSource datasource)</code>
	 * @param datasource
	 */
	@Deprecated
	public abstract void remove(String datasource);

	public abstract void remove(DataSource datasource);

	public abstract void release();

}