com.atlassian.activeobjects.spi

Interface DataSourceProvider

All Known Implementing Classes:

DataSourceProviderImpl

public interface DataSourceProvider

Gives access to the host application data source. Products that are tenanted should instead implement TenantAwareDataSourceProvider.

Method Summary

Modifier and Type	Method and Description
DatabaseType	getDatabaseType() Returns the database type.
DataSource	getDataSource() Returns the host application's SQL data source.
String	getSchema() Returns the name of the schema used with this database.

Method Detail

getDataSource

DataSource getDataSource()

Returns the host application's SQL data source.

Returns:

see above

getDatabaseType

DatabaseType getDatabaseType()

Returns the database type.

Note: if DatabaseType.UNKNOWN is returned, it is up to the calling code to 'guess' the type of the database. It is strongly advised to implement this method so that it never returns DatabaseType.UNKNOWN.

Returns:

a valid database type

getSchema

@Nullable
String getSchema()

Returns the name of the schema used with this database.

This is especially important for SQL Server, Postgres, and HSQLDB.

Returns:

the name of the schema to use, null if no schema is required.