javax.sql

インタフェース CommonDataSource

既知のすべてのサブインタフェース:

ConnectionPoolDataSource、DataSource、XADataSource

public interface CommonDataSource

DataSource、XADataSource、および ConnectionPoolDataSource に共通のメソッドを定義するインタフェースです。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
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 - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.4

関連項目:

setLogWriter(java.io.PrintWriter)

setLogWriter

void setLogWriter(PrintWriter out)
                  throws SQLException

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

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

パラメータ:

out - 新しいログライター。ロギングを無効にする場合は null に設定する

例外:

SQLException - データベースアクセスエラーが発生した場合

導入されたバージョン:

1.4

関連項目:

getLogWriter()

setLoginTimeout

void setLoginTimeout(int seconds)
                     throws SQLException

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

パラメータ:

seconds - データソースのログイン制限時間

例外:

SQLException - データベースアクセスエラーが発生した場合。

導入されたバージョン:

1.4

関連項目:

getLoginTimeout()

getLoginTimeout

int getLoginTimeout()
                    throws SQLException

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

戻り値:

データソースのログイン制限時間

例外:

SQLException - データベースアクセスエラーが発生した場合。

導入されたバージョン:

1.4

関連項目:

setLoginTimeout(int)

getParentLogger

Logger getParentLogger()
                       throws SQLFeatureNotSupportedException

このデータソースによって使用されるすべてのロガーの親ロガーを返します。これはこのデータソースによって使用されているすべてのロガーの上位ロガーであるルートロガーからもっとも遠いロガーになるはずです。このロガーを構成すると、データソースによって生成されたすべてのログメッセージに影響します。最悪の場合、これがルート Logger になる可能性があります。

戻り値:

このデータソースの親ロガー

例外:

SQLFeatureNotSupportedException - データソースが java.util.logging を使用しない場合。

導入されたバージョン:

1.7