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

インタフェースConnectionPoolDataSource

すべてのスーパー・インタフェース:
CommonDataSource
public interface ConnectionPoolDataSource
extends CommonDataSource
PooledConnectionオブジェクトのファクトリです。 このインタフェースを実装するオブジェクトは、一般に、Java™ Naming and Directory Interface (JNDI)を基にしたネーム・サービスに登録されています。
導入されたバージョン:
1.4

  • メソッドのサマリー

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

    インタフェース javax.sql.CommonDataSourceで宣言されたメソッド

    createShardingKeyBuilder, getParentLogger

  • メソッドの詳細

    • getPooledConnection

      PooledConnection getPooledConnection() throws SQLException
      プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。
      戻り値:
      このConnectionPoolDataSourceオブジェクトが表すデータベースへの物理接続であるPooledConnectionオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      1.4

    • getPooledConnection

      PooledConnection getPooledConnection​(String user, String password) throws SQLException
      プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。
      パラメータ:
      user - その代理として接続が行われるデータベース・ユーザー
      password - ユーザーのパスワード
      戻り値:
      このConnectionPoolDataSourceオブジェクトが表すデータベースへの物理接続であるPooledConnectionオブジェクト
      例外:
      SQLException - データベース・アクセス・エラーが発生した場合
      SQLFeatureNotSupportedException - JDBCドライバがこのメソッドをサポートしない場合
      導入されたバージョン:
      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)

    • createPooledConnectionBuilder

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