7.11.3.1 XA準拠リソース・マネージャを使用するJAX-RSアプリケーションの構成

XA準拠のリソース・マネージャを使用する場合は、この項に記載されている情報を使用してJAX-RS参加側アプリケーションを構成します。

  1. MicroTxクライアント・ライブラリのプロパティ値を指定します。

    次の例では、プロパティのサンプル値を指定しています。ご自身の環境に基づいて値を指定してください。

    oracle.tmm.TcsConnPoolSize = 15
    oracle.tmm.CallbackUrl = https://bookTicket-app:8081
    oracle.tmm.PropagateTraceHeaders = true
    oracle.tmm.TransactionTimeout = 60000
    oracle.tmm.xa.XaSupport = true

    oracle.tmm.xa.XaSupporttrueに設定されていることを確認します。

    各プロパティおよびその他のオプション・プロパティの詳細は、「JAX-RSおよびNode.jsアプリケーションのライブラリ・プロパティの構成」を参照してください。

  2. MicroTx Javaライブラリ・ファイルをアプリケーションのpom.xmlファイルにmaven依存関係として含めます。次のサンプル・コードは24.4リリース用です。使用するリリース・バージョンに基づいて、正しいバージョンを指定してください。
    • Helidon 2.xなどのJakarta EE8環境では、TmmLibファイルを使用します。

      <dependency>
           <groupId>com.oracle.tmm.jta</groupId>
           <artifactId>TmmLib</artifactId>
           <version>24.4</version>
      </dependency>
    • Helidon 3.xアプリケーションなどのJakarta EE9環境では、TmmLib-jakartaファイルを使用します。

      <dependency>
           <groupId>com.oracle.tmm.jta</groupId>
           <artifactId>TmmLib-jakarta</artifactId>
           <version>24.4</version>
      </dependency>
  3. XADatasourceオブジェクトを初期化します。

    MicroTxクライアント・ライブラリは、XADatasourceオブジェクトにアクセスする必要があります。このオブジェクトを使用してXAConnectionオブジェクトおよびXAResourceオブジェクトを作成し、リソース・マネージャまたはデータベース・サーバーに接続します。次のコードでは、接続オブジェクトを作成する際にアプリケーション・コードの先頭にXADatasourceオブジェクトをどのように定義するかを示しています。

    class oracle.tmm.jta.TrmConfig
    static void initXaDataSource(XADataSource xaDs)

    XADataSourceの詳細は、https://docs.oracle.com/javase/8/docs/api/javax/sql/XADataSource.htmlを参照してください。

  4. トランザクション参加側関数またはブロックで、MicroTxクライアント・ライブラリで使用されるXADatasourceオブジェクトを指定します。リソース・マネージャに接続するための資格証明およびその他の詳細を指定します。
    //Example for a participant using an Oracle Database:
    OracleXADataSource dataSource = new oracle.jdbc.xa.client.OracleXADataSource();
    dataSource.setURL(url); //database connection string
    dataSource.setUser(user); //username to access database
    dataSource.setPassword(password); //password to access database
    TrmConfig.initXaDataSource((XADataSource)dataSource);

    アプリケーション開発者は、XADataSourceを割り当てる際に、XA準拠JDBCドライバおよび必要なパラメータを設定する必要があります。

    MicroTxクライアント・ライブラリは、XADatasourceオブジェクトを使用してデータベース接続を作成します。

  5. トランザクション参加側の関数すなわちブロックで、XADatasourceオブジェクトを初期化した後に次のコード行を1回だけ追加します。
    oracle.tmm.jta.TrmConfig.initXaDataSource((XADataSource)xaDs);

    XADatasourceはJTAで定義されたインタフェースであり、JDBCドライバによって実装が提供されます。

    MicroTxクライアント・ライブラリは、このオブジェクトを使用してデータベースに接続し、XAトランザクションを開始し、準備、コミット、ロールバックなどの様々な操作を実行します。MicroTxライブラリは、依存関係インジェクションを使用してDMLを実行するためのSQL接続オブジェクトもアプリケーション・コードに提供します。

  6. 参加側サービスのコードに次の行を挿入して、アプリケーションがMicroTxクライアント・ライブラリによって渡された接続を使用するようにします。参加側アプリケーションの次のコードは、MicroTxクライアント・ライブラリによって作成されたconnectionオブジェクトを注入します。
    @Inject
    @TrmSQLConnection 
    private Connection connection;
  7. 参加側サービスのコードに次の行を挿入して、参加側サービスがDML操作を実行するたびに、注入されたconnectionオブジェクトを使用するようにします。
    Statement stmt1 = connection.createStatement();
    stmt1.execute(query);
    stmt1.close();

    ここで、connectionは、前のステップで注入したConnectionオブジェクトの名前です。

    これらのコード行は、参加側サービスが実行するDML操作ごとに挿入します。DML操作ごとにstmt1stmt2などの新しい文オブジェクトを作成しますが、MicroTxクライアント・ライブラリによって作成された同一のconnectionオブジェクトを使用します。

  8. JAX-RS APIを使用するSpring Bootアプリケーションの場合のみ、XAトランザクションに参加するリソース・エンドポイントを登録した後で次のタスクを実行します。
    1. 次のサンプル・コード・スニペットに示すように、準備、コミット、ロールバックのために、フィルタとXAResourceCallbacksを登録します。

      @Component
      public class JerseyConfig extends ResourceConfig
      {
          public JerseyConfig()
          {
              // Register the MicroTx XA resource callback which
              // coordinates with the transaction coordinator
              register(XAResourceCallbacks.class);
              // Register the filters for the MicroTx libraries that 
              // intercept the JAX_RS calls and manage the XA transactions
              register(TrmTransactionResponseFilter.class);
              register(TrmTransactionRequestFilter.class);
              
              // Bind the connection
              ...
          }
      }
    2. Spring Bootアプリケーションで1つのリソース・マネージャを使用している場合は、TrmXAConnectionFactoryオブジェクトをXAConnectionにバインドします。後で、TrmXAConnectionFactoryオブジェクト(MicroTx接続ファクトリ・オブジェクト)を使用します。これによってMicroTxが接続を処理します。

      @Component
      public class JerseyConfig extends ResourceConfig
      {
          public JerseyConfig()
          {
              // Register the filters as shown in the previous step
              ....
      
              register(new AbstractBinder() {
                  @Override
                  protected void configure() {
                  //Bind the TrmXAConnectionFactory object to an XAConnection object
                  bindFactory(TrmXAConnectionFactory.class).to(XAConnection.class);
                  }
              });
          }
      }
  9. 変更内容を保存します。
複数のJAX-RSトランザクション参加側サービスがある場合は、すべての参加側サービスでこれらのステップを完了します。

MicroTxライブラリおよびXAトランザクション・プロトコルを使用するサンプルJAX-RSトランザクション参加側アプリケーションのソース・コードは、microtx-samples GitHubリポジトリにあるdepartment-helidonフォルダにあります。これは、MicroTxライブラリとアプリケーションの統合時に参照として使用できます。