Package io.micronaut.transaction.jdbc

Class DataSourceUtils

java.lang.Object
io.micronaut.transaction.jdbc.DataSourceUtils
public abstract class DataSourceUtils extends Object
Helper class that provides static methods for obtaining JDBC Connections from a DataSource. Includes special support for Spring-managed transactional Connections, e.g. managed by DataSourceTransactionManager
Author:
Rod Johnson, Juergen Hoeller, graemerocher
See Also:

  • Field Details

    • CONNECTION_SYNCHRONIZATION_ORDER

      public static final int CONNECTION_SYNCHRONIZATION_ORDER
      Order value for TransactionSynchronization objects that clean up JDBC Connections.
      See Also:

  • Constructor Details

    • DataSourceUtils

      public DataSourceUtils()

  • Method Details

    • getConnection

      public static Connection getConnection(DataSource dataSource) throws CannotGetJdbcConnectionException
      Obtain a Connection from the given DataSource. Translates SQLExceptions into the Spring hierarchy of unchecked generic data access exceptions, simplifying calling code and making any exception that is thrown more meaningful.

      Is aware of a corresponding Connection bound to the current thread, for example when using DataSourceTransactionManager. Will bind a Connection to the thread if transaction synchronization is active.

      Parameters:
      dataSource - the DataSource to obtain Connections from
      Returns:
      a JDBC Connection from the given DataSource
      Throws:
      CannotGetJdbcConnectionException - if the attempt to get a Connection failed
      See Also:

    • getConnection

      public static Connection getConnection(DataSource dataSource, boolean allowCreate) throws CannotGetJdbcConnectionException
      Obtain a Connection from the given DataSource. Translates SQLExceptions into the Spring hierarchy of unchecked generic data access exceptions, simplifying calling code and making any exception that is thrown more meaningful.

      Is aware of a corresponding Connection bound to the current thread, for example when using DataSourceTransactionManager. Will bind a Connection to the thread if transaction synchronization is active.

      Parameters:
      dataSource - the DataSource to obtain Connections from
      allowCreate - If true allow the creation of a new connection if non is bound
      Returns:
      a JDBC Connection from the given DataSource
      Throws:
      CannotGetJdbcConnectionException - if the attempt to get a Connection failed
      See Also:

    • prepareConnectionForTransaction

      @Nullable public static TransactionDefinition.Isolation prepareConnectionForTransaction(Connection con, @Nullable TransactionDefinition definition) throws SQLException
      Prepare the given Connection with the given transaction semantics.
      Parameters:
      con - the Connection to prepare
      definition - the transaction definition to apply
      Returns:
      the previous isolation level, if any
      Throws:
      SQLException - if thrown by JDBC methods
      See Also:

    • resetConnectionAfterTransaction

      public static void resetConnectionAfterTransaction(Connection con, @Nullable TransactionDefinition.Isolation previousIsolationLevel)
      Reset the given Connection after a transaction, regarding read-only flag and isolation level.
      Parameters:
      con - the Connection to reset
      previousIsolationLevel - the isolation level to restore, if any
      See Also:

    • isConnectionTransactional

      public static boolean isConnectionTransactional(Connection con, @Nullable DataSource dataSource)
      Determine whether the given JDBC Connection is transactional, that is, bound to the current thread by Spring's transaction facilities.
      Parameters:
      con - the Connection to check
      dataSource - the DataSource that the Connection was obtained from (may be null)
      Returns:
      whether the Connection is transactional

    • applyTransactionTimeout

      public static void applyTransactionTimeout(Statement stmt, @Nullable DataSource dataSource) throws SQLException
      Apply the current transaction timeout, if any, to the given JDBC Statement object.
      Parameters:
      stmt - the JDBC Statement object
      dataSource - the DataSource that the Connection was obtained from
      Throws:
      SQLException - if thrown by JDBC methods
      See Also:

    • applyTimeout

      public static void applyTimeout(Statement stmt, @Nullable DataSource dataSource, int timeout) throws SQLException
      Apply the specified timeout - overridden by the current transaction timeout, if any - to the given JDBC Statement object.
      Parameters:
      stmt - the JDBC Statement object
      dataSource - the DataSource that the Connection was obtained from
      timeout - the timeout to apply (or 0 for no timeout outside of a transaction)
      Throws:
      SQLException - if thrown by JDBC methods
      See Also:

    • releaseConnection

      public static void releaseConnection(@Nullable Connection con, @Nullable DataSource dataSource)
      Close the given Connection, obtained from the given DataSource, if it is not managed externally (that is, not bound to the thread).
      Parameters:
      con - the Connection to close if necessary (if this is null, the call will be ignored)
      dataSource - the DataSource that the Connection was obtained from (may be null)
      See Also:

    • doReleaseConnection

      public static void doReleaseConnection(@Nullable Connection con, @Nullable DataSource dataSource) throws SQLException
      Actually close the given Connection, obtained from the given DataSource. Same as releaseConnection(java.sql.Connection, javax.sql.DataSource), but throwing the original SQLException.
      Parameters:
      con - the Connection to close if necessary (if this is null, the call will be ignored)
      dataSource - the DataSource that the Connection was obtained from (may be null)
      Throws:
      SQLException - if thrown by JDBC methods
      See Also:
      • doGetConnection(javax.sql.DataSource, boolean)

    • doCloseConnection

      public static void doCloseConnection(Connection con, @Nullable DataSource dataSource) throws SQLException
      Close the Connection.
      Parameters:
      con - the Connection to close if necessary
      dataSource - the DataSource that the Connection was obtained from
      Throws:
      SQLException - if thrown by JDBC methods
      See Also:

    • getTargetConnection

      public static Connection getTargetConnection(Connection con)
      Return the innermost target Connection of the given Connection. If the given Connection is a proxy, it will be unwrapped until a non-proxy Connection is found. Otherwise, the passed-in Connection will be returned as-is.
      Parameters:
      con - the Connection proxy to unwrap
      Returns:
      the innermost target Connection, or the passed-in one if no proxy