org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider.java Source code

Introduction

Here is the source code for org.hibernate.engine.jdbc.connections.spi.MultiTenantConnectionProvider.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.engine.jdbc.connections.spi;

import java.sql.Connection;
import java.sql.SQLException;

import org.hibernate.service.Service;
import org.hibernate.service.spi.Wrapped;

/**
 * A specialized Connection provider contract used when the application is using multi-tenancy support requiring
 * tenant aware connections.
 *
 * @author Steve Ebersole
 */
public interface MultiTenantConnectionProvider extends Service, Wrapped {
    /**
     * 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).
     *
     * @return The database metadata.
     *
     * @throws SQLException Indicates a problem opening a connection
     */
    public Connection getAnyConnection() throws SQLException;

    /**
     * Release a connection obtained from {@link #getAnyConnection}
     *
     * @param connection The JDBC connection to release
     *
     * @throws SQLException Indicates a problem closing the connection
     */
    public void releaseAnyConnection(Connection connection) throws SQLException;

    /**
     * Obtains a connection for Hibernate use according to the underlying strategy of this provider.
     *
     * @param tenantIdentifier The identifier of the tenant for which to get a connection
     *
     * @return The obtained JDBC connection
     *
     * @throws SQLException Indicates a problem opening a connection
     * @throws org.hibernate.HibernateException Indicates a problem otherwise obtaining a connection.
     */
    public Connection getConnection(String tenantIdentifier) throws SQLException;

    /**
     * Release a connection from Hibernate use.
     *
     * @param connection The JDBC connection to release
     * @param tenantIdentifier The identifier of the tenant.
     *
     * @throws SQLException Indicates a problem closing the connection
     * @throws org.hibernate.HibernateException Indicates a problem otherwise releasing a connection.
     */
    public void releaseConnection(String tenantIdentifier, Connection connection) throws SQLException;

    /**
     * Does this connection provider support aggressive release of JDBC
     * connections and re-acquisition of those connections (if need be) later?
     * <p/>
     * This is used in conjunction with {@link org.hibernate.cfg.Environment#RELEASE_CONNECTIONS}
     * to aggressively release JDBC connections.  However, the configured ConnectionProvider
     * must support re-acquisition of the same underlying connection for that semantic to work.
     * <p/>
     * 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.
     *
     * @return {@code true} if aggressive releasing is supported; {@code false} otherwise.
     */
    public boolean supportsAggressiveRelease();
}