com.google.enterprise.connector.util.database

Class JdbcDatabase

java.lang.Object

com.google.enterprise.connector.util.database.JdbcDatabase

Direct Known Subclasses:

TestJdbcDatabase

public class JdbcDatabase
extends java.lang.Object

Basic database connectivity, table creation and connection pooling.

The JdbcDatabase wraps a DataSource instance, adding additional features specifically beneficial to Connectors and the ConnectorManager, such as:

• Information regarding the underlying database implementation, including the vendor name, version information, and description.
• Maintaining a ConnectionPool for the DataSource.
• Manufacturing legal database table names base upon a Connector name.
• Creating database tables based upon a supplied DDL, or verifying that such a table exists.
• Methods useful for forming DatabaseResourceBundle filenames for the specific vendor implementation.

Since:

2.8

Constructor Summary

Constructors

Constructor and Description
JdbcDatabase(javax.sql.DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
DatabaseConnectionPool	getConnectionPool() Return the DatabaseConnectionPool used to maintain a collection of opened Connections to the DataSource.
SpiConstants.DatabaseType	getDatabaseType() Return the SpiConstants.DatabaseType for this database.
javax.sql.DataSource	getDataSource() Return the underlying DataSource for the database instance.
java.lang.String	getDescription() Return a description string for this database.
int	getMaxTableNameLength() Returns the maximum table name length for this database vendor.
java.lang.String	getProductName() Return a sanitzed version of the vendor product name.
java.lang.String	getResourceBundleExtension() Returns the DatabaseResourceBundle extension that may be added to a ResourceBundle baseName to build the name of the resource that is specific to the database implementation identified by this JdbcDatabase instance.
boolean	isDisabled() Returns true if the configured JdbcDatabase is unavailable.
java.lang.String	makeTableName(java.lang.String prefix, java.lang.String connectorName) Constructs a database table name based up the configured table name prefix and the Connector name.
void	shutdown()
java.lang.String	toString()
boolean	verifyTableExists(java.lang.String tableName, java.lang.String[] createTableDdl) Verify that a table named tableName exists in the database.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JdbcDatabase

public JdbcDatabase(javax.sql.DataSource dataSource)

Method Detail

shutdown

public void shutdown()

isDisabled

public boolean isDisabled()

Returns true if the configured JdbcDatabase is unavailable.

Returns:

true if this JdbcDatabase is disabled, false otherwise.

getDataSource

public javax.sql.DataSource getDataSource()

Return the underlying DataSource for the database instance.

Returns:

the underlying DataSource for the database instance.

getConnectionPool

public DatabaseConnectionPool getConnectionPool()

Return the DatabaseConnectionPool used to maintain a collection of opened Connections to the DataSource.

Returns:

the DatabaseConnectionPool for this database

getDatabaseType

public SpiConstants.DatabaseType getDatabaseType()

Return the SpiConstants.DatabaseType for this database.

Returns:

the SpiConstants.DatabaseType for this database

getProductName

public java.lang.String getProductName()

Return a sanitzed version of the vendor product name. This sanitized string is used to create the resourceBundleExtension and will generally match one of the supported DatabaseTypes.

Returns:

the sanitized product name

getDescription

public java.lang.String getDescription()

Return a description string for this database. This may be a vendor-supplied string or simply the unsanitized product name and version string.

Returns:

the description string

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getResourceBundleExtension

public java.lang.String getResourceBundleExtension()

Returns the DatabaseResourceBundle extension that may be added to a ResourceBundle baseName to build the name of the resource that is specific to the database implementation identified by this JdbcDatabase instance.

This is will be constructed from the database productName, majorVersion, and minorVersion separated by underbars ('_'), for instance MySQL v5.6 will return "_mysql_5_6".

Returns:

the resource bundle extension

getMaxTableNameLength

public int getMaxTableNameLength()

Returns the maximum table name length for this database vendor.

makeTableName

public java.lang.String makeTableName(java.lang.String prefix,
                                      java.lang.String connectorName)

Constructs a database table name based up the configured table name prefix and the Connector name. All attempts are made to make this a straight concatenation. However if the connector name is too long or contains invalid SQL identifier characters, then it is constructed from an MD5 hash of the requested name.

Parameters:

prefix - the generated table name will begin with this prefix

connectorName - the connector name

verifyTableExists

public boolean verifyTableExists(java.lang.String tableName,
                                 java.lang.String[] createTableDdl)

Verify that a table named tableName exists in the database. If not, create it, using the supplied DDL statements.

Parameters:

tableName - the name of the table to find in the database.

createTableDdl - DDL statements that may be used to create the table if it does not exist. If null, no attempt will be made to create the table.

Returns:

true if the table exists or was successfully created, false if the table does not exist.