javax.sql
インタフェース XADataSource

public interface XADataSource

内部で使用される XAConnection オブジェクトのファクトリです。XADataSource インタフェースを実装するオブジェクトは、一般に、Java^TM Naming and Directory Interface (JNDI) を使用するネームサービスで登録されます。

導入されたバージョン:

1.4

メソッドの概要

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

メソッドの詳細

getXAConnection

public XAConnection getXAConnection()
                             throws SQLException

分散トランザクションで使用可能な、物理データベース接続の確立を試みます。

戻り値:

データソースへの物理接続を表す XAConnection オブジェクト。このオブジェクトは分散トランザクションで使用される

例外:

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

getXAConnection

public XAConnection getXAConnection(String user,
                                    String password)
                             throws SQLException

指定されたユーザ名とパスワードを使用して、物理データベース接続の確立を試みます。返される接続は、分散トランザクションで使用できます。

パラメータ:

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

password - ユーザのパスワード

戻り値:

データソースへの物理接続を表す XAConnection オブジェクト。このオブジェクトは分散トランザクションで使用される

例外:

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

getLogWriter

public PrintWriter getLogWriter()
                         throws SQLException

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

戻り値:

このデータソースのログライター。ログライターが設定されていない場合は、ログの取得が無効であることを表す null

例外:

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

関連項目:

setLogWriter(java.io.PrintWriter)

setLogWriter

public void setLogWriter(PrintWriter out)
                  throws SQLException

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

ログライターとは、この XADataSource オブジェクトのすべてのログおよびトレースメッセージの出力先キャラクタ出力ストリームのことです。このオブジェクトのメソッドによるメッセージや、このオブジェクトが作成したほかのオブジェクトによるメッセージなども含まれます。データソースに固有のログライターに出力されたメッセージは、java.sql.DriverManager クラスに関連付けられたログライターには出力されません。データソースオブジェクトが作成されると、ログライターは null に初期化されます。

パラメータ:

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

例外:

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

関連項目:

getLogWriter()

setLoginTimeout

public void setLoginTimeout(int seconds)
                     throws SQLException

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

パラメータ:

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

例外:

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

関連項目:

getLoginTimeout()

getLoginTimeout

public int getLoginTimeout()
                    throws SQLException

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

戻り値:

この XADataSource オブジェクトによるログインの制限時間を表す秒数。タイムアウトの制限がない場合や、デフォルトのシステムタイムアウトである場合は 0

例外:

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

関連項目:

setLoginTimeout(int)