javax.sql
インタフェース ConnectionPoolDataSource

public interface ConnectionPoolDataSource

PooledConnection オブジェクトのファクトリです。このインタフェースを実装するオブジェクトは、一般に、Java^TM Naming and Directory Interface (JNDI) を基にしたネームサービスで登録されています。

導入されたバージョン:

1.4

メソッドの概要

int	getLoginTimeout() データベースへの接続試行中に、この ConnectionPoolDataSource オブジェクトが待機する最長時間 (秒) を取得します。
PrintWriter	getLogWriter() この ConnectionPoolDataSource オブジェクトのログライターを取得します。
PooledConnection	getPooledConnection() プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。
PooledConnection	getPooledConnection(String user, String password) プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。
void	setLoginTimeout(int seconds) データベースへの接続試行中に、この ConnectionPoolDataSource オブジェクトが待機する最長時間 (秒) を指定します。
void	setLogWriter(PrintWriter out) この ConnectionPoolDataSource オブジェクトのログライターを java.io.PrintWriter オブジェクトに設定します。

メソッドの詳細

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。

戻り値:

この ConnectionPoolDataSource オブジェクトが表すデータベースへの物理接続である PooledConnection オブジェクト

例外:

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

getPooledConnection

public PooledConnection getPooledConnection(String user,
                                            String password)
                                     throws SQLException

プールされた接続として使用可能な、データベースへの物理接続の確立を試みます。

パラメータ:

user - その代理として接続が行われるデータベースユーザ

password - ユーザのパスワード

戻り値:

この ConnectionPoolDataSource オブジェクトが表すデータベースへの物理接続である PooledConnection オブジェクト

例外:

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

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

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

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

戻り値:

この ConnectionPoolDataSource のログライター。ログの取得が無効の場合は null

例外:

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

関連項目:

setLogWriter(java.io.PrintWriter)

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

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

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

パラメータ:

out - 新しいログライター。ログの取得を無効にする場合は null

例外:

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

関連項目:

getLogWriter()

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

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

パラメータ:

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

例外:

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

関連項目:

getLoginTimeout()

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

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

戻り値:

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

例外:

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

関連項目:

setLoginTimeout(int)