Interface MultiTenantConnectionProvider<T>
- Type Parameters:
T
- The tenant identifier type
- All Superinterfaces:
Serializable
,Service
,Wrapped
- All Known Implementing Classes:
AbstractDataSourceBasedMultiTenantConnectionProviderImpl
,AbstractMultiTenantConnectionProvider
,DataSourceBasedMultiTenantConnectionProviderImpl
Connection
provider contract used when the application is using
multi-tenancy support requiring tenant-aware connections.
A MultiTenantConnectionProvider
may be selected using the configuration property
"hibernate.multi_tenant_connection_provider".
An application usually implements its own custom MultiTenantConnectionProvider
by subclassing AbstractMultiTenantConnectionProvider
.
-
Method Summary
Modifier and TypeMethodDescriptionAllows access to the database metadata of the underlying database(s) in situations where we do not have a tenant id (like startup processing, for example).getConnection
(T tenantIdentifier) Obtains a connection for use according to the underlying strategy of this provider.default DatabaseConnectionInfo
getDatabaseConnectionInfo
(Dialect dialect) void
releaseAnyConnection
(Connection connection) Release a connection obtained fromgetAnyConnection()
void
releaseConnection
(T tenantIdentifier, Connection connection) Release a connection from Hibernate use.boolean
Does this connection provider support aggressive release of JDBC connections and later re-acquisition of those connections if needed?Methods inherited from interface org.hibernate.service.spi.Wrapped
isUnwrappableAs, unwrap
-
Method Details
-
getAnyConnection
Allows access to the database metadata of the underlying database(s) in situations where we do not have a tenant id (like startup processing, for example).- Returns:
- The database metadata.
- Throws:
SQLException
- Indicates a problem opening a connection
-
releaseAnyConnection
Release a connection obtained fromgetAnyConnection()
- Parameters:
connection
- The JDBC connection to release- Throws:
SQLException
- Indicates a problem closing the connection
-
getConnection
Obtains a connection for use according to the underlying strategy of this provider.- Parameters:
tenantIdentifier
- The identifier of the tenant for which to get a connection- Returns:
- The obtained JDBC connection
- Throws:
SQLException
- Indicates a problem opening a connectionHibernateException
- Indicates a problem otherwise obtaining a connection.
-
releaseConnection
Release a connection from Hibernate use.- Parameters:
connection
- The JDBC connection to releasetenantIdentifier
- The identifier of the tenant.- Throws:
SQLException
- Indicates a problem closing the connectionHibernateException
- Indicates a problem otherwise releasing a connection.
-
supportsAggressiveRelease
boolean supportsAggressiveRelease()Does this connection provider support aggressive release of JDBC connections and later re-acquisition of those connections if needed?This is used in conjunction with
ConnectionReleaseMode.AFTER_STATEMENT
to aggressively release JDBC connections. However, the configuredConnectionProvider
must support re-acquisition of the same underlying connection for that semantic to work.Typically, this is only true in managed environments where a container tracks connections by transaction or thread.
Note that JTA semantic depends on the fact that the underlying connection provider does support aggressive release.
- Returns:
true
if aggressive releasing is supported;false
otherwise.
-
getDatabaseConnectionInfo
-