JDBCXAConnection (HSQLDB 2.4.1 API)
Date: 2018-05-20

org.hsqldb.jdbc.pool

## Class JDBCXAConnection

- java.lang.Object
- - org.hsqldb.jdbc.pool.JDBCPooledConnection
  - - org.hsqldb.jdbc.pool.JDBCXAConnection

- All Implemented Interfaces:
    javax.sql.PooledConnection, javax.sql.XAConnection, JDBCConnectionEventListener

      public class JDBCXAConnection
      extends JDBCPooledConnection
      implements javax.sql.XAConnection

  Subclass of JDBCPooledConnection implements the XAConnection interface. For use by global transaction service managers.

  Each instance has an JDBCXAResource inherits the superclass's two JDBCConnection objects, one for internal access, and one for user access.

  The getConnection() method returns a user connection and links this with the JDBCXAResource. This puts the object in the inUse state. When the user connection is closed, the object is put in the free state.

  Since:
    HSQLDB 2.0
  Author:
    Fred Toussi (fredt at users.sourceforge.net)
  See Also:
    `XAConnection`

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `JDBCXAConnection(JDBCXADataSource dataSource, JDBCConnection connection)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()`
    `java.sql.Connection` | `getConnection()` Returns a connection that can be used by the user application.
    `javax.transaction.xa.XAResource` | `getXAResource()`

    - ### Methods inherited from class org.hsqldb.jdbc.pool.JDBCPooledConnection

      `addConnectionEventListener, addStatementEventListener, connectionClosed, connectionErrorOccurred, isInUse, release, removeConnectionEventListener, removeStatementEventListener, reset`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface javax.sql.PooledConnection

      `addConnectionEventListener, addStatementEventListener, removeConnectionEventListener, removeStatementEventListener`

- - ### Constructor Detail

    - #### JDBCXAConnection

          public JDBCXAConnection(JDBCXADataSource dataSource,
                                  JDBCConnection connection)

  - ### Method Detail

    - #### getXAResource

          public javax.transaction.xa.XAResource getXAResource()
                                                        throws java.sql.SQLException

      Specified by:
        `getXAResource` in interface `javax.sql.XAConnection`
      Throws:
        `java.sql.SQLException`

    - #### getConnection

          public java.sql.Connection getConnection()
                                            throws java.sql.SQLException

      Returns a connection that can be used by the user application.
      Specified by:
        `getConnection` in interface `javax.sql.PooledConnection`
      Overrides:
        `getConnection` in class `JDBCPooledConnection`
      Returns:
        Connection
      Throws:
        `java.sql.SQLException` - if a lease has already been given on this connection

    - #### close

          public void close()
                     throws java.sql.SQLException

      Specified by:
        `close` in interface `javax.sql.PooledConnection`
      Overrides:
        `close` in class `JDBCPooledConnection`
      Throws:
        `java.sql.SQLException`

Copyright © 2001 - 2018 HSQL Development Group.