Package org.hibernate.resource.jdbc.spi

Interface JdbcSessionOwner

All Known Subinterfaces:
EventSource, SessionImplementor, SharedSessionContractImplementor, StatelessSessionImplementor
All Known Implementing Classes:
SessionDelegatorBaseImpl, SharedSessionDelegatorBaseImpl
public interface JdbcSessionOwner
Contract for something that controls a JdbcSessionContext.

The term JDBC session is taken from the SQL specification which calls a connection and its associated transaction context a "session".

API Note:
The name comes from the design idea of a JdbcSession which encapsulates this information, which we will hopefully get back to later.

  • Method Details

    • getJdbcSessionContext

      JdbcSessionContext getJdbcSessionContext()

    • getJdbcConnectionAccess

      JdbcConnectionAccess getJdbcConnectionAccess()

    • getTransactionCoordinator

      TransactionCoordinator getTransactionCoordinator()
      Obtain the TransactionCoordinator.
      Returns:
      The TransactionCoordinator

    • startTransactionBoundary

      void startTransactionBoundary()
      Callback indicating recognition of entering into a transactional context whether that is explicitly via the Hibernate Transaction API or via registration of Hibernate's JTA Synchronization impl with a JTA Transaction

    • afterTransactionBegin

      void afterTransactionBegin()
      An after-begin callback from the coordinator to its owner.

    • beforeTransactionCompletion

      void beforeTransactionCompletion()
      A before-completion callback to the owner.

    • afterTransactionCompletion

      void afterTransactionCompletion(boolean successful, boolean delayed)
      An after-completion callback to the owner.
      Parameters:
      successful - Was the transaction successful?
      delayed - Is this a delayed after transaction completion call (aka after a timeout)?

    • flushBeforeTransactionCompletion

      void flushBeforeTransactionCompletion()

    • getJdbcBatchSize

      Integer getJdbcBatchSize()
      Get the session-level JDBC batch size.
      Returns:
      session-level JDBC batch size
      Since:
      5.2

    • getSqlExceptionHelper

      default SqlExceptionHelper getSqlExceptionHelper()

    • afterObtainConnection

      @Incubating void afterObtainConnection(Connection connection) throws SQLException
      Called after a managed JDBC connection is obtained.

      Sets the schema to the schema belonging to the current tenant if:

      1. "hibernate.multi_tenant.schema_mapper" is enabled, and
      2. this session has an active tenant id.
      Parameters:
      connection - A JDBC connection which was just acquired
      Throws:
      SQLException
      Since:
      7.1

    • beforeReleaseConnection

      @Incubating void beforeReleaseConnection(Connection connection) throws SQLException
      Called right before a managed JDBC connection is released.

      Unset the schema which was set by afterObtainConnection(java.sql.Connection), if any. .

      Parameters:
      connection - The JDBC connection which is about to be released
      Throws:
      SQLException
      Since:
      7.1

    • getEventMonitor

      EventMonitor getEventMonitor()
      Obtain a reference to the EventMonitor.
      Since:
      7.0

    • getEventManager

      @Deprecated(since="7.0", forRemoval=true) default EventManager getEventManager()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getEventMonitor().
      Obtain a reference to the EventMonitor dressed up as an instance of EventManager.
      Since:
      6.4