com.google.enterprise.connector.spi

Interface LocalDatabase

All Known Implementing Classes:

com.google.enterprise.connector.util.database.LocalDatabaseImpl, TestLocalDatabase

public interface LocalDatabase

Provides access to the Connector Manager's configured JDBC database which the connector implementer can use for any purpose.

Since:

2.8

See Also:

ConnectorPersistentStore

Method Summary

Modifier and Type	Method and Description
DatabaseResourceBundle	getDatabaseResourceBundle() Gets a DatabaseResourceBundle through which the connector implementor can get database-specific resources, such as SQL.
SpiConstants.DatabaseType	getDatabaseType() Returns a SpiConstants.DatabaseType enum identifying the database implementation.
javax.sql.DataSource	getDataSource() Gets a DataSource which the connector implementer can use for any purpose.
java.lang.String	getDescription() Returns a String giving a description of the database.

Method Detail

getDataSource

javax.sql.DataSource getDataSource()

Gets a DataSource which the connector implementer can use for any purpose.

Returns:

a DataSource

getDatabaseResourceBundle

DatabaseResourceBundle getDatabaseResourceBundle()

Gets a DatabaseResourceBundle through which the connector implementor can get database-specific resources, such as SQL. The DatabaseResourceBundle returned will be constructed by the Connector Manager to return resources specific to this connector's type and to the specific database version currently in use. See the Developer's guide for details on how implementors can supply resources to the installation.

Returns:

a DatabaseResourceBundle

getDatabaseType

SpiConstants.DatabaseType getDatabaseType()

Returns a SpiConstants.DatabaseType enum identifying the database implementation.

Returns:

a non-null SpiConstants.DatabaseType enum identifying the database implementation.

getDescription

java.lang.String getDescription()

Returns a String giving a description of the database.

For now, the form of this string is intentionally under-specified, for flexibility. The SPI only guarantees that, if this object's database type is not SpiConstants.DatabaseType.OTHER, then this string begins with the string-value of that SpiConstants.DatabaseType. More formally, for any LocalDatabase object db then the following is true: (db.getDatabaseInfoString().startsWith(db.getDatabase().toString())) || (db.getDatabase() == DatabaseType.OTHER). If the database type is "other", then the string should start with a simple name of the database (rather than the "unsupported").

The remainder of the string is reserved to hold additional information, such as version.

Returns:

a non-null String description of the database