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 java.io.Serializable;
027 import java.sql.Connection;
028 import java.sql.DatabaseMetaData;
029 import java.util.Properties;
030
031 /**
032 * Database Meta data provider
033 *
034 * @author <a href="mailto:litsenko_sergey@yahoo.com">Sergiy Litsenko</a>
035 */
036 public interface DatabaseMetadataProvider extends Serializable {
037 // ~ Methods --------------------------------------------------------------------------
038
039 /**
040 * Releases database resources
041 *
042 * @param silently if true never generates Exception; otherwise mage rethrow RunTimeException
043 */
044 void release( boolean silently );
045
046 /**
047 * Returns database metadata
048 *
049 * @return database metadata
050 * @throws Exception
051 */
052 DatabaseMetaData getDatabaseMetaData() throws Exception;
053
054 /**
055 * Returns database connection
056 *
057 * @return database connection
058 * @throws Exception
059 */
060 Connection getConnection() throws Exception;
061
062 /**
063 * Returns DatabaseMetadataProvider logical name
064 *
065 * @return the DatabaseMetadataProvider logical name
066 */
067 String getName();
068
069 /**
070 * Sets the DatabaseMetadataProvider logical name
071 *
072 * @param name the DatabaseMetadataProvider logical name
073 */
074 void setName( String name );
075
076 /**
077 * Get provider's notation for empty string
078 *
079 * @return provider's notation for empty string
080 */
081 String getEmptyStringNotation();
082
083 /**
084 * Set provider's notation for empty string
085 *
086 * @param emptyStringNotation the provider's notation for empty string
087 */
088 void setEmptyStringNotation( String emptyStringNotation );
089
090 /**
091 * Get provider's notation for NULL string
092 *
093 * @return provider's notation for NULL string
094 */
095 String getNullStringNotation();
096
097 /**
098 * Set provider's notation for NULL string
099 *
100 * @param nullStringNotation the provider's notation for NULL string
101 */
102 void setNullStringNotation( String nullStringNotation );
103
104 /**
105 * Returns provider properties
106 *
107 * @return provider properties
108 */
109 Properties getProperties();
110
111 /**
112 * Sets the provider properties
113 *
114 * @param properties the provider properties
115 */
116 void setProperties( Properties properties );
117 }