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
026/**
027 * Interface for retrieving pre-processed, cached, database meta data.
028 * 
029 * @author Paul Ferraro
030 * @since 2.0
031 */
032public interface DatabaseMetaDataCache
033{
034        /**
035         * Flushes this cache.
036         * @throws SQLException if flush fails
037         */
038        public void flush() throws SQLException;
039        
040        /**
041         * Retrieves processed meta data for this database.
042         * @return a DatabaseProperties implementation
043         * @throws SQLException if database properties could not be fetched.
044         */
045        public DatabaseProperties getDatabaseProperties(Connection connection) throws SQLException;
046}