001/*
002 * HA-JDBC: High-Availability JDBC
003 * Copyright (c) 2004-2007 Paul Ferraro
004 * 
005 * This library is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published by the 
007 * Free Software Foundation; either version 2.1 of the License, or (at your 
008 * option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful, but WITHOUT
011 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
012 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License 
013 * for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public License
016 * along with this library; if not, write to the Free Software Foundation, 
017 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
018 * 
019 * Contact: ferraro@users.sourceforge.net
020 */
021package net.sf.hajdbc;
022
023import java.sql.Connection;
024import java.sql.SQLException;
025
026import javax.management.DynamicMBean;
027
028/**
029 * @author  Paul Ferraro
030 * @version $Revision: 1536 $
031 * @param <D> either java.sql.Driver or javax.sql.DataSource
032 * @since   1.0
033 */
034public interface Database<D> extends InactiveDatabaseMBean, Comparable<Database<D>>
035{
036        /**
037         * Connects to the database using the specified connection factory.
038         * @param connectionFactory a factory object for creating connections
039         * @return a database connection
040         * @throws SQLException if connection fails
041         */
042        public Connection connect(D connectionFactory) throws SQLException;
043        
044        /**
045         * Factory method for creating a connection factory object for this database.
046         * @return a connection factory object
047         * @throws IllegalArgumentException if connection factory could not be created
048         */
049        public D createConnectionFactory();
050        
051        public DynamicMBean getActiveMBean();
052        
053        public DynamicMBean getInactiveMBean();
054        
055        public boolean isDirty();
056        
057        public void clean();
058}