001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.common.jdbc.provider;
025    
026    import javax.sql.DataSource;
027    
028    /**
029     * DataSource based Database Metadata Provider (such as JEE App container based)
030     * 
031     * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
032     */
033    public interface DataSourceDatabaseMetadataProvider extends DatabaseMetadataProvider {
034        // ~ Methods --------------------------------------------------------------------------
035    
036        /**
037         * Returns DataSource
038         * 
039         * @return DataSource
040         * @throws Exception 
041         */
042        DataSource getDataSource() throws Exception;
043    
044        /**
045         * Gets data source JNDI name
046         * 
047         * @return data source JNDI name
048         */
049        String getDataSourceName();
050    
051        /**
052         * Sets data source JNDI name
053         * 
054         * @param dataSourceName the data source JNDI name
055         */
056        void setDataSourceName( String dataSourceName );
057    }