モジュール java.sql
パッケージ javax.sql

インタフェースXADataSource

  • すべてのスーパー・インタフェース:
    CommonDataSource
    public interface XADataSource
extends CommonDataSource
    内部で使用されるXAConnectionオブジェクトのファクトリです。 XADataSourceインタフェースを実装するオブジェクトは、一般に、Java Naming and Directory Interface™ (JNDI)を使用するネーム・サービスに登録されます。

    XADataSourceの実装には引数なしのpublicコンストラクタが含まれている必要があります。

    導入されたバージョン:
    1.4

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      default XAConnectionBuilder createXAConnectionBuilder()
      新しいXAConnectionBuilderインスタンスを作成
      int getLoginTimeout()
      データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を取得します。
      PrintWriter getLogWriter()
      このDataSourceオブジェクトのログ・ライターを取得します。
      XAConnection getXAConnection()
      分散トランザクションで使用可能な、物理データベース接続の確立を試みます。
      XAConnection getXAConnection​(String user, String password)
      指定されたユーザー名とパスワードを使用して、物理データベース接続の確立を試みます。
      void setLoginTimeout​(int seconds)
      データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。
      void setLogWriter​(PrintWriter out)
      このDataSourceオブジェクトのログ・ライターをjava.io.PrintWriterオブジェクトに設定します。

    • メソッドの詳細

      • getXAConnection

        XAConnection getXAConnection()
                      throws SQLException
        分散トランザクションで使用可能な、物理データベース接続の確立を試みます。
        戻り値:
        データ・ソースへの物理接続を表すXAConnectionオブジェクト。このオブジェクトは分散トランザクションで使用される
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
        SQLTimeoutException - ドライバが、setLoginTimeoutメソッドで指定されたタイムアウト値が経過したと判定し、少なくとも現在のデータベース接続の試みを取り消そうとしたとき
        導入されたバージョン:
        1.4

      • getXAConnection

        XAConnection getXAConnection​(String user,
                             String password)
                      throws SQLException
        指定されたユーザー名とパスワードを使用して、物理データベース接続の確立を試みます。 返される接続は、分散トランザクションで使用できます。
        パラメータ:
        user - その代理として接続が行われるデータベース・ユーザー
        password - ユーザーのパスワード
        戻り値:
        データ・ソースへの物理接続を表すXAConnectionオブジェクト。このオブジェクトは分散トランザクションで使用される
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
        SQLTimeoutException - ドライバが、setLoginTimeoutメソッドで指定されたタイムアウト値が経過したと判定し、少なくとも現在のデータベース接続の試みを取り消そうとしたとき
        導入されたバージョン:
        1.4

      • getLogWriter

        PrintWriter getLogWriter()
                  throws SQLException

        このDataSourceオブジェクトのログ・ライターを取得します。

        ログ・ライターとは、このデータ・ソースに対するすべてのロギング・メッセージやトレース・メッセージの出力先となるキャラクタ出力ストリームのことです。 このオブジェクトのメソッドによって出力されたメッセージや、このオブジェクトが作成した他のオブジェクトのメソッドによって出力されたメッセージなども含まれます。 データ・ソース固有のログ・ライターに表示されたメッセージは、java.sql.DriverManagerクラスに関連付けられたログ・ライターには出力されません。 DataSourceオブジェクトが作成されると、ログ・ライターはnullに初期化されます。つまり、デフォルトではロギングは無効です。

        定義:
        インタフェースCommonDataSource内のgetLogWriter
        戻り値:
        このデータ・ソースのログ・ライター。ログの取得が無効の場合はnull
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4
        関連項目:
        CommonDataSource.setLogWriter(java.io.PrintWriter)

      • setLogWriter

        void setLogWriter​(PrintWriter out)
           throws SQLException

        このDataSourceオブジェクトのログ・ライターをjava.io.PrintWriterオブジェクトに設定します。

        ログ・ライターとは、このデータ・ソースに対するすべてのロギング・メッセージやトレース・メッセージの出力先となるキャラクタ出力ストリームのことです。 このオブジェクトのメソッドによって出力されたメッセージや、このオブジェクトが作成した他のオブジェクトのメソッドによって出力されたメッセージなども含まれます。 データ・ソース固有のログ・ライターに表示されたメッセージは、java.sql.DriverManagerクラスに関連付けられたログ・ライターには出力されません。 DataSourceオブジェクトが作成されると、ログ・ライターはnullに初期化されます。つまり、デフォルトではロギングは無効です。

        定義:
        インタフェースCommonDataSource内のsetLogWriter
        パラメータ:
        out - 新しいログ・ライター。ロギングを無効にする場合はnullに設定する
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.4
        関連項目:
        CommonDataSource.getLogWriter()

      • setLoginTimeout

        void setLoginTimeout​(int seconds)
              throws SQLException

        データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。 値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。 DataSourceオブジェクトが作成されると、ログイン・タイムアウトは0に初期化されます。

        定義:
        インタフェースCommonDataSource内のsetLoginTimeout
        パラメータ:
        seconds - データ・ソースのログイン制限時間
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合。
        導入されたバージョン:
        1.4
        関連項目:
        CommonDataSource.getLoginTimeout()

      • getLoginTimeout

        int getLoginTimeout()
             throws SQLException
        データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を取得します。 値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。 DataSourceオブジェクトが作成されると、ログイン・タイムアウトは0に初期化されます。
        定義:
        インタフェースCommonDataSource内のgetLoginTimeout
        戻り値:
        データ・ソースのログイン制限時間
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合。
        導入されたバージョン:
        1.4
        関連項目:
        CommonDataSource.setLoginTimeout(int)

      • createXAConnectionBuilder

        default XAConnectionBuilder createXAConnectionBuilder()
                                               throws SQLException
        新しいXAConnectionBuilderインスタンスを作成
        実装要件:
        デフォルトの実装では、SQLFeatureNotSupportedExceptionがスローされます。
        戻り値:
        作成されたXAConnectionBuilderインスタンス
        例外:
        SQLException - ビルダーの作成中にエラーが発生した場合
        SQLFeatureNotSupportedException - 運転手がシャーディングをサポートしていない場合
        導入されたバージョン:
        9
        関連項目:
        XAConnectionBuilder