インタフェースCommonDataSource

既知のすべてのサブインタフェース:
ConnectionPoolDataSource, DataSource, XADataSource
public interface CommonDataSource
DataSource、XADataSource、およびConnectionPoolDataSourceに共通のメソッドを定義するインタフェースです。
導入されたバージョン:
1.6

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default ShardingKeyBuilder
    createShardingKeyBuilder()
    新しいShardingKeyBuilderインスタンスを作成
    int
    getLoginTimeout()
    データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を取得します。
    PrintWriter
    getLogWriter()
    このDataSourceオブジェクトのログ・ライターを取得します。
    Logger
    getParentLogger()
    このデータ・ソースによって使用されるすべてのロガーの親ロガーを返します。
    void
    setLoginTimeout(int seconds)
    データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。
    void
    setLogWriter(PrintWriter out)
    このDataSourceオブジェクトのログ・ライターをjava.io.PrintWriterオブジェクトに設定します。

  • メソッドの詳細

    • getLogWriter

      PrintWriter getLogWriter() throws SQLException

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

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

      戻り値:
      このデータ・ソースのログ・ライター。ログの取得が無効の場合はnull
      スロー:
      SQLException - データベース・アクセス・エラーが発生した場合
      関連項目:

    • setLogWriter

      void setLogWriter(PrintWriter out) throws SQLException

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

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

      パラメータ:
      out - 新しいログ・ライター。ロギングを無効にする場合はnullに設定する
      スロー:
      SQLException - データベース・アクセス・エラーが発生した場合
      関連項目:

    • setLoginTimeout

      void setLoginTimeout(int seconds) throws SQLException

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

      パラメータ:
      seconds - データ・ソースのログイン制限時間
      スロー:
      SQLException - データベース・アクセス・エラーが発生した場合。
      関連項目:

    • getLoginTimeout

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

    • getParentLogger

      Logger getParentLogger() throws SQLFeatureNotSupportedException
      このデータ・ソースによって使用されるすべてのロガーの親ロガーを返します。 これはこのデータ・ソースによって使用されているすべてのロガーの上位ロガーであるルート・ロガーからもっとも遠いロガーになるはずです。 このロガーを構成すると、データ・ソースによって生成されたすべてのログ・メッセージに影響します。 最悪の場合、これがルートLoggerになる可能性があります。
      戻り値:
      このデータ・ソースの親ロガー
      スロー:
      SQLFeatureNotSupportedException - データ・ソースがjava.util.loggingを使用しない場合
      導入されたバージョン:
      1.7

    • createShardingKeyBuilder

      default ShardingKeyBuilder createShardingKeyBuilder() throws SQLException
      新しいShardingKeyBuilderインスタンスを作成
      実装要件:
      デフォルトの実装では、SQLFeatureNotSupportedExceptionがスローされます。
      戻り値:
      作成されたShardingKeyBuilderインスタンス
      スロー:
      SQLException - ビルダーの作成中にエラーが発生した場合
      SQLFeatureNotSupportedException - ドライバがこのメソッドをサポートしていない場合
      導入されたバージョン:
      9
      関連項目: