XAConnection (DoqueDB JDBC Document (javadoc))

java.lang.Object
- jp.co.ricoh.doquedb.jdbcx.XAConnection

すべての実装されたインタフェース:

javax.sql.PooledConnection, javax.sql.XAConnection, javax.transaction.xa.XAResource
```
public class XAConnection
extends java.lang.Object
implements javax.sql.XAConnection, javax.transaction.xa.XAResource
```
接続プール管理のフックを提供するオブジェクトです。 PooledConnection オブジェクトは、データソースへの物理接続を表します。アプリケーションがある接続で終了したとき、その接続は閉じられずにリサイクルされます。そのため、生成する必要のある接続数を減らすことができます。アプリケーションプログラマが PooledConnection インタフェースを直接使用することはありません。むしろ、PooledConnection インタフェースは、接続のプーリングを管理する中間層インフラストラクチャが使用します。 XAConnectionは上記のインターフェースを継承しています。

フィールドのサマリー
- インタフェースから継承されたフィールド javax.transaction.xa.XAResource
  TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

XAConnection(java.sql.Connection con_, boolean autoCommit_)
新しいXAConnectionを作成します。

コンストラクタ
コンストラクタと説明
`XAConnection(java.sql.Connection con_, boolean autoCommit_)` 新しいXAConnectionを作成します。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`addConnectionEventListener(javax.sql.ConnectionEventListener connectionEventListener_)` 指定したイベントリスナーを登録して、この PooledConnection オブジェクトでイベントが発生したときに通知されるようにします。
`void`	`addStatementEventListener(javax.sql.StatementEventListener listener)` [サポート外]
`void`	`close()` この PooledConnection オブジェクトが表す物理接続を閉じます。
`void`	`commit(javax.transaction.xa.Xid xid_, boolean onePhase_)` トランザクションブランチ識別子で識別されるトランザクションブランチをコミットする。
`void`	`end(javax.transaction.xa.Xid xid_, int flags_)` SUSPEND句またはSUSPEND FOR MIGRATE句を指定しないとき、トランザクションブランチ識別子で識別されるトランザクションブランチを待機する。
`void`	`forget(javax.transaction.xa.Xid xid_)` 状態が『ヒューリスティックな解決済』のトランザクションブランチ識別子で識別されるトランザクションブランチのどうやって解決したかの情報を抹消する。
`java.sql.Connection`	`getConnection()` この PooledConnection オブジェクトが表す物理接続のオブジェクトハンドルを作成します。
`int`	`getTransactionTimeout()` この XAResource インスタンスに対して設定された現在のトランザクションタイムアウト値を取得します。
`javax.transaction.xa.XAResource`	`getXAResource()` XAResourceを取得する。
`boolean`	`isSameRM(javax.transaction.xa.XAResource xares_)` ターゲットオブジェクトで表されるリソースマネージャインスタンスがパラメータ xares で表されるリソースマネージャインスタンスと同じかどうかを判定する。
`int`	`prepare(javax.transaction.xa.Xid xid_)` トランザクションブランチ識別子で識別されるトランザクションブランチをコミット準備する。
`javax.transaction.xa.Xid[]`	`recover(int flag_)` 状態が『コミット準備完了』・『ヒューリスティックな解決済』のトランザクションブランチのトランザクションブランチ識別子を得る。
`void`	`removeConnectionEventListener(javax.sql.ConnectionEventListener connectionEventListener_)` 指定したイベントリスナーを、この PooledConnection オブジェクトでイベントが発生したときに通知されるコンポーネントのリストから削除します。
`void`	`removeStatementEventListener(javax.sql.StatementEventListener listener)` [サポート外]
`void`	`rollback(javax.transaction.xa.Xid xid_)` トランザクションブランチ識別子で識別されるトランザクションブランチをロールバックする。
`boolean`	`setTransactionTimeout(int timeout_)` この XAResource インスタンスの現在のトランザクションタイムアウト値を設定します。
`void`	`start(javax.transaction.xa.Xid xid_, int flg_)` トランザクションブランチ識別子で識別されるトランザクションブランチを開始する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - XAConnection
```
public XAConnection(java.sql.Connection con_,
                    boolean autoCommit_)
```
    新しいXAConnectionを作成します。
    
    パラメータ:
    
    con_ - コネクションオブジェクト
    
    autoCommit_ - オートコミットかどうか
- メソッドの詳細
  - addConnectionEventListener
```
public void addConnectionEventListener(javax.sql.ConnectionEventListener connectionEventListener_)
```
    指定したイベントリスナーを登録して、この PooledConnection オブジェクトでイベントが発生したときに通知されるようにします。
    
    定義:
    
    addConnectionEventListener インタフェース内 javax.sql.PooledConnection
    
    パラメータ:
    
    connectionEventListener_ - インタフェースを実装し、接続が閉じたかエラーが発生したときに通知されるようにするコンポーネント。通常は接続プール管理プログラム
  - removeConnectionEventListener
```
public void removeConnectionEventListener(javax.sql.ConnectionEventListener connectionEventListener_)
```
    指定したイベントリスナーを、この PooledConnection オブジェクトでイベントが発生したときに通知されるコンポーネントのリストから削除します。
    
    定義:
    
    removeConnectionEventListener インタフェース内 javax.sql.PooledConnection
    
    パラメータ:
    
    connectionEventListener_ - インタフェースを実装し、リスナーとして登録されたコンポーネント。通常は接続プール管理プログラム
  - close
```
public void close()
           throws java.sql.SQLException
```
    この PooledConnection オブジェクトが表す物理接続を閉じます。
    
    定義:
    
    close インタフェース内 javax.sql.PooledConnection
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - getConnection
```
public java.sql.Connection getConnection()
                                  throws java.sql.SQLException
```
    この PooledConnection オブジェクトが表す物理接続のオブジェクトハンドルを作成します。返されるオブジェクトは、プールされている物理接続 (この PooledConnection オブジェクト) を参照するアプリケーションコードで使用する一時ハンドルになります。
    
    定義:
    
    getConnection インタフェース内 javax.sql.PooledConnection
    
    戻り値:
    
    この PooledConnection オブジェクトのハンドルである java.sql.Connection オブジェクト
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - getXAResource
```
public javax.transaction.xa.XAResource getXAResource()
                                              throws java.sql.SQLException
```
    XAResourceを取得する。
    
    定義:
    
    getXAResource インタフェース内 javax.sql.XAConnection
    
    戻り値:
    
    javax.transaction.xa.XAResource オブジェクト
    
    例外:
    
    java.sql.SQLException - データベースアクセスエラーが発生した場合
  - commit
```
public void commit(javax.transaction.xa.Xid xid_,
                   boolean onePhase_)
            throws javax.transaction.xa.XAException
```
    トランザクションブランチ識別子で識別されるトランザクションブランチをコミットする。トランザクションブランチのコミット ::= XA COMMIT トランザクションブランチ識別子 [ONE PHASE]
    
    定義:
    
    commit インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    onePhase_ - ONE PHASE句指定の有無
    
    例外:
    
    XA_ProtocolError - ONE PHASE句を指定するときに『待機中』もしくは『コミット準備完了』でない場合
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    XA_Heur - トランザクションブランチの状態が『ヒューリスティックな解決済』である場合
    
    javax.transaction.xa.XAException
  - end
```
public void end(javax.transaction.xa.Xid xid_,
                int flags_)
         throws javax.transaction.xa.XAException
```
    SUSPEND句またはSUSPEND FOR MIGRATE句を指定しないとき、トランザクションブランチ識別子で識別されるトランザクションブランチを待機する。 SUSPEND句またはSUSPEND FOR MIGRATE句を指定すると、トランザクションブランチの実行を中断できる。トランザクションブランチの待機 ::= XA END トランザクションブランチ識別子 [ SUSPEND [ FOR MIGRATE ] ] SUSPEND句およびSUSPEND FOR MIGRATE句は現在、サポートしない。
    
    定義:
    
    end インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    flags_ - SUSPEND句の指定等
    
    例外:
    
    XA_ProtocolError - ・SUSPEND句またはSUSPEND FOR MIGRATE句を指定しないときに、　トランザクションブランチの状態が『データ操作中』・『中断中』でない場合・SUSPEND句またはSUSPEND FOR MIGRATE句を指定したときに、　トランザクションブランチの状態が『データ操作中』でない場合・このSQL文を実行するセッションでXA STARTにより開始・合流・再開したトランザクションブランチでない場合
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    javax.transaction.xa.XAException
  - forget
```
public void forget(javax.transaction.xa.Xid xid_)
            throws javax.transaction.xa.XAException
```
    状態が『ヒューリスティックな解決済』のトランザクションブランチ識別子で識別されるトランザクションブランチのどうやって解決したかの情報を抹消する。ヒューリステックに解決済のトランザクションブランチの抹消 ::= XA FORGET トランザクションブランチ識別子
    
    定義:
    
    forget インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    例外:
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在してかつ『ヒューリスティックな解決済』でない場合
    
    javax.transaction.xa.XAException
  - getTransactionTimeout
```
public int getTransactionTimeout()
                          throws javax.transaction.xa.XAException
```
    この XAResource インスタンスに対して設定された現在のトランザクションタイムアウト値を取得します。
    
    定義:
    
    getTransactionTimeout インタフェース内 javax.transaction.xa.XAResource
    
    戻り値:
    
    トランザクションタイムアウト値
    
    例外:
    
    javax.transaction.xa.XAException
  - isSameRM
```
public boolean isSameRM(javax.transaction.xa.XAResource xares_)
                 throws javax.transaction.xa.XAException
```
    ターゲットオブジェクトで表されるリソースマネージャインスタンスがパラメータ xares で表されるリソースマネージャインスタンスと同じかどうかを判定する。
    
    定義:
    
    isSameRM インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xares_ - ターゲットオブジェクトのリソースマネージャインスタンスと比較されるリソースマネージャインスタンスを持つ XAResource オブジェクト
    
    戻り値:
    
    同じ RM インスタンスである場合は true、そうでない場合は false
    
    例外:
    
    javax.transaction.xa.XAException
  - prepare
```
public int prepare(javax.transaction.xa.Xid xid_)
            throws javax.transaction.xa.XAException
```
    トランザクションブランチ識別子で識別されるトランザクションブランチをコミット準備する。トランザクションブランチのコミット準備 ::= XA PREPARE トランザクションブランチ識別子
    
    定義:
    
    prepare インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    戻り値:
    
    XA_RDONLY または XA_OK
    
    例外:
    
    XA_ProtocolError - トランザクションブランチの状態が『待機中』でない場合
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    javax.transaction.xa.XAException
  - recover
```
public javax.transaction.xa.Xid[] recover(int flag_)
                                   throws javax.transaction.xa.XAException
```
    状態が『コミット準備完了』・『ヒューリスティックな解決済』のトランザクションブランチのトランザクションブランチ識別子を得る。コミット準備済トランザクションブランチの確認 ::= XA RECOVER
    
    定義:
    
    recover インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    flag_ - TMSTARTRSCAN、TMENDRSCAN、TMNOFLAGSのいずれか
    
    戻り値:
    
    XA_RDONLY または XA_OK
    
    例外:
    
    XA_ProtocolError - トランザクションブランチの状態が『待機中』でない場合
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    javax.transaction.xa.XAException
  - rollback
```
public void rollback(javax.transaction.xa.Xid xid_)
              throws javax.transaction.xa.XAException
```
    トランザクションブランチ識別子で識別されるトランザクションブランチをロールバックする。トランザクションブランチのロールバック ::= XA ROLLBACK トランザクションブランチ識別子
    
    定義:
    
    rollback インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    例外:
    
    XA_ProtocolError - トランザクションブランチの状態が『待機中』・『コミット準備完了』・『ロールバックのみ可』でない場合
    
    XA_UnknownIdentifier - トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    XA_Heur - トランザクションブランチの状態が『ヒューリスティックな解決済』である場合
    
    javax.transaction.xa.XAException
  - setTransactionTimeout
```
public boolean setTransactionTimeout(int timeout_)
                              throws javax.transaction.xa.XAException
```
    この XAResource インスタンスの現在のトランザクションタイムアウト値を設定します。
    
    定義:
    
    setTransactionTimeout インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    timeout_ - トランザクションタイムアウト値
    
    戻り値:
    
    トランザクションタイムアウト値が正常に設定された場合は true、そうでない場合は false
    
    例外:
    
    javax.transaction.xa.XAException
  - start
```
public void start(javax.transaction.xa.Xid xid_,
                  int flg_)
           throws javax.transaction.xa.XAException
```
    トランザクションブランチ識別子で識別されるトランザクションブランチを開始する。トランザクションブランチの開始 ::= XA START トランザクションブランチ識別子 [ { <トランザクションモード> [ { <カンマ> <トランザクションモード> } ... ] } | JOIN | RESUME ] ただし、JOIN句およびRESUME句は現在、サポートしない。
    
    定義:
    
    start インタフェース内 javax.transaction.xa.XAResource
    
    パラメータ:
    
    xid_ - グローバルトランザクション識別子
    
    flg_ - JOIN句の指定等
    
    例外:
    
    XA_DuplicateIdentifier - 『データ操作中』・『中断中』・『待機中』のトランザクションブランチに対し、後述するJOIN句やRESUME句を指定せずにこのSQL文を実行した場合
    
    XA_ProtocolError - 『コミット準備完了』・『ヒューリスティックな解決済』・『ロールバックのみ可』の状態のトランザクションブランチに対し、このSQL文を実行した場合
    
    XA_UnknownIdentifier - JOIN句やRESUME句を指定したとき、トランザクションブランチ識別子で識別されるトランザクションブランチが存在しない場合
    
    javax.transaction.xa.XAException
  - addStatementEventListener
```
public void addStatementEventListener(javax.sql.StatementEventListener listener)
```
    [サポート外]
    
    定義:
    
    addStatementEventListener インタフェース内 javax.sql.PooledConnection
  - removeStatementEventListener
```
public void removeStatementEventListener(javax.sql.StatementEventListener listener)
```
    [サポート外]
    
    定義:
    
    removeStatementEventListener インタフェース内 javax.sql.PooledConnection

クラス XAConnection

フィールドのサマリー

インタフェースから継承されたフィールド javax.transaction.xa.XAResource

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

XAConnection

メソッドの詳細

addConnectionEventListener

removeConnectionEventListener

close

getConnection

getXAResource

commit

end

forget

getTransactionTimeout

isSameRM

prepare

recover

rollback

setTransactionTimeout

start

addStatementEventListener

removeStatementEventListener