パッケージ jakarta.jms

インターフェース XAConnectionFactory

  • すべての既知のサブインターフェース:
    XAQueueConnectionFactory, XATopicConnectionFactory
    public interface XAConnectionFactory
    XAConnectionFactory インターフェースは、XAQueueConnectionFactory および XATopicConnectionFactory インターフェースの基本インターフェースです。

    一部のアプリケーションサーバーは、JTA 対応のリソース使用を分散トランザクションにグループ化するためのサポートを提供します（オプション）。JTA トランザクションに Jakarta Messaging API トランザクションを含めるには、アプリケーションサーバーに JTA 対応の JMS プロバイダーが必要です。Jakarta Messaging プロバイダーは、アプリケーションサーバーが XAConnection オブジェクトを作成するために使用する XAConnectionFactory オブジェクトを使用して JTA サポートを公開します。

    XAConnectionFactory オブジェクトは、ConnectionFactory オブジェクトと同様に、Jakarta Messaging が管理するオブジェクトです。アプリケーションサーバーは、Java Naming and Directory Interface（JNDI）API を使用して見つけることが期待されています。

    XAConnectionFactory インターフェースはオプションです。Jakarta Messaging プロバイダーは、このインターフェースをサポートする必要はありません。このインターフェースは、トランザクション環境をサポートするために Jakarta Messaging プロバイダーが使用するためのものです。クライアントプログラムでは、これらの XA インターフェースを直接使用するのではなく、環境で利用可能なトランザクションサポートを使用することを強くお勧めします。

    導入:
    JMS 1.0
    バージョン:
    Jakarta Messaging 2.0

    • メソッドの詳細

      • createXAConnection

        XAConnection createXAConnection()
                         throws JMSException
        デフォルトのユーザー ID で XAConnection を作成します。接続は停止モードで作成されます。Connection.start メソッドが明示的に呼び出されるまで、メッセージは配信されません。
        戻り値:
        新しく作成された XAConnection
        例外:
        JMSException - 内部エラーが原因で Jakarta Messaging プロバイダーが XA 接続の作成に失敗した場合。
        JMSSecurityException - 無効なユーザー名またはパスワードが原因でクライアント認証が失敗した場合。
        導入:
        JMS 1.1

      • createXAConnection

        XAConnection createXAConnection​(StringSE userName,
                                StringSE password)
                         throws JMSException
        指定されたユーザー ID で XAConnection を作成します。接続は停止モードで作成されます。Connection.start メソッドが明示的に呼び出されるまで、メッセージは配信されません。
        パラメーター:
        userName - 呼び出し元のユーザー名
        password - 呼び出し元のパスワード
        戻り値:
        新しく作成された XAConnection
        例外:
        JMSException - 内部エラーが原因で Jakarta Messaging プロバイダーが XA 接続の作成に失敗した場合。
        JMSSecurityException - 無効なユーザー名またはパスワードが原因でクライアント認証が失敗した場合。
        導入:
        JMS 1.1

      • createXAContext

        XAJMSContext createXAContext()
        デフォルトのユーザー ID で XAJMSContext を作成します

        新しい XAJMSContext で使用するために、接続とセッションが作成されます。接続は停止モードで作成されますが、JMSConsumer が作成されると自動的に開始されます。

        戻り値:
        新しく作成された XAJMSContext
        例外:
        JMSRuntimeException - 内部エラーが原因で Jakarta Messaging プロバイダーが XAJMSContext の作成に失敗した場合。
        JMSSecurityRuntimeException - 無効なユーザー名またはパスワードが原因でクライアント認証が失敗した場合。
        導入:
        JMS 2.0

      • createXAContext

        XAJMSContext createXAContext​(StringSE userName,
                             StringSE password)
        指定されたユーザー ID で JMSContext を作成します

        新しい XAJMSContext で使用するために、接続とセッションが作成されます。接続は停止モードで作成されますが、JMSConsumer が作成されると自動的に開始されます。

        パラメーター:
        userName - 呼び出し元のユーザー名
        password - 呼び出し元のパスワード
        戻り値:
        新しく作成された JMSContext
        例外:
        JMSRuntimeException - 内部エラーのために Jakarta Messaging プロバイダーが JMSContext の作成に失敗した場合
        JMSSecurityRuntimeException - 無効なユーザー名またはパスワードが原因でクライアント認証が失敗した場合。
        導入:
        JMS 2.0