com.atlassian.activeobjects.spi

Interface TenantAwareDataSourceProvider

All Known Implementing Classes:

AbstractTenantAwareDataSourceProvider, ConfluenceTenantAwareDataSourceProvider, JiraTenantAwareDataSourceProvider

public interface TenantAwareDataSourceProvider

Gives access to the host application data source.

Method Summary

Modifier and Type	Method and Description
DatabaseType	getDatabaseType(com.atlassian.tenancy.api.Tenant tenant) Returns the database type for the tenant
DataSource	getDataSource(com.atlassian.tenancy.api.Tenant tenant) Provide host application data source associated with a tenant.
String	getSchema(com.atlassian.tenancy.api.Tenant tenant) The name of the schema used with this database for the tenant.

Method Detail

getDataSource

@Nonnull
DataSource getDataSource(@Nonnull
                                  com.atlassian.tenancy.api.Tenant tenant)

Provide host application data source associated with a tenant. This data source will be used for the entire lifetime of com.atlassian.activeobjects.external.ActiveObjects

getDatabaseType

@Nonnull
DatabaseType getDatabaseType(@Nonnull
                                      com.atlassian.tenancy.api.Tenant tenant)

Returns the database type for the tenant

Note: if DatabaseType.UNKNOWN is return it is left up to the client of the data source provider 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

See Also:

DatabaseType

getSchema

String getSchema(@Nonnull
                 com.atlassian.tenancy.api.Tenant tenant)

The name of the schema used with this database for the tenant.

This is especially import for SQL Server, PostgresQL and HSQLDB

Returns:

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