org.apache.commons.dbcp.cpdsadapter
クラス DriverAdapterCPDS

java.lang.Object
  拡張org.apache.commons.dbcp.cpdsadapter.DriverAdapterCPDS
すべての実装インタフェース:
ConnectionPoolDataSource, ObjectFactory, Referenceable, Serializable

public class DriverAdapterCPDS
extends Object
implements ConnectionPoolDataSource, Referenceable, Serializable, ObjectFactory

ConnectionPoolDataSource の実装は持っていないが DriverManager の実装は持っているJDBCドライバのためのアダプタです。 ConnectionPoolDataSource は、(まだ)一般的なアプリケーションでは使用されていません。 これらは Jdbc2PoolDataSource と同じように Connection をプールする DataSource の実装に使用されます。 J2EE コンテナは普通 ConnectionPoolDataSource を初期化するためのいくつかの方法を提供し、 初期化の為の属性は bean のゲッタ/セッタにて参照され、JNDI を経てデプロイされます。 これはプールを行っている DataSource が新たな接続を必要とした時のデータベースに対する物理的な接続の生成元として利用することができます。

普通、 DriverAdapterCPDS は JNDI 環境で使用されますが、 DriverAdapterCPDS は他の bean と同じようにインスタンス化、初期化され、プールを行う DataSource に直接アタッチされます。 Jdbc2PoolDataSource は JNDI を利用してもしなくても ConnectionPoolDataSource を使用することができます。

また DriverAdapterCPDS は JDBC2 の ConnectionPoolDataSource 実装では一般的に利用できないが JDBC3 の仕様には含まれる PreparedStatement のプーリング機能を提供します。 DriverAdapterCPDS の PreparedStatement のプール(の実装)はいままで dbcp パッケージに含まれていましたが、ここで扱われる設定での広範囲なテストを経ていませんでした。 この機能は実験的なものと考えるべきで、poolPreparedStatements 属性にて切り替えることができます。

パッケージドキュメント には catalina と JNDI を使用した例が含まれています。 jdbc2pool パッケージドキュメント には、JNDI を使用せずに Jdbc2PoolDataSource の接続取得元として DriverAdapterCPDS を使用する方法が含まれています。

バージョン:
$Id: DriverAdapterCPDS.java,v 1.1.1.1 2004/02/13 10:02:03 hioki Exp $
作成者:
John D. McNally
関連項目:
直列化された形式
翻訳者:
日置 聡

コンストラクタの概要
DriverAdapterCPDS()
          Serialization のための引数のないデフォルトコンストラクタ。
 
メソッドの概要
 String getDescription()
          記述情報(Description)の値を取得します。
 String getDriver()
          ドライバのクラス名を取得します。
 int getLoginTimeout()
          このデータソースがデータベースとの接続を試みる場合に待機する最長時間(秒)を取得します。
 PrintWriter getLogWriter()
          このデータソースのログライターを取得します。
 int getMaxActive()
          このプールから1度に割り当てることのできるアクティブなステートメントの最大数です。
 int getMaxIdle()
          余分なものを開放せずにプール内にアイドル状態で保持できるステートメントの最大数です。
 int getMinEvictableIdleTimeMillis()
          アイドル状態のオブジェクトがプール内に居られる最短時間を返します。
 int getNumTestsPerEvictionRun()
          アイドル状態のオブジェクトを排除するスレッドが1度の動作でチェックの対象とするステートメントの数を返します。
 Object getObjectInstance(Object refObj, Name name, Context context, Hashtable env)
          このクラスのインスタンスを生成するための ObjectFactory の実装です。
 String getPassword()
          デフォルトユーザのパスワードの値を取得します。
 PooledConnection getPooledConnection()
          デフォルトのユーザ、パスワードを使用してデータベースへの接続の確立を試みます。
 PooledConnection getPooledConnection(String username, String password)
          データベースへの接続の確立を試みます。
 Reference getReference()
          Referenceable の実装です。
 int getTimeBetweenEvictionRunsMillis()
          アイドル状態のオブジェクトを排除するスレッドが次の動作までスリープする時間を示すミリセカンドの値を返します。
 String getUrl()
          このデータソースがデータベースの位置を認識するためのURLの値を取得します。
 String getUser()
          デフォルトユーザ(ログイン名 または ユーザ名)の値を取得します。
 boolean isPoolPreparedStatements()
          PreparedStatement のプーリング機能の切り替えフラグです。
 void setDescription(String v)
          記述情報(Description)の値を設定します。
 void setDriver(String v)
          ドライバのクラス名を設定します。
 void setLoginTimeout(int seconds)
          このデータソースがデータベースとの接続を試みる場合に待機する最長時間(秒)を設定します。
 void setLogWriter(PrintWriter out)
          このデータソースのログライターを設定します。
 void setMaxActive(int maxActive)
          このプールから1度に割り当てることのできるアクティブなステートメントの最大数です。
 void setMaxIdle(int maxIdle)
          余分なものを開放せずにプール内にアイドル状態で保持できるステートメントの最大数です。
 void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)
          アイドル状態のオブジェクトがプール内に居られる最短時間を設定します。
 void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
          アイドル状態のオブジェクトを排除するスレッドが1度の動作でチェックの対象とするステートメントの数を返します。
 void setPassword(String v)
          デフォルトユーザのパスワードの値を設定します。
 void setPoolPreparedStatements(boolean v)
          PreparedStatement のプーリング機能の切り替えフラグです。
 void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
          アイドル状態のオブジェクトを排除するスレッドが次の動作までスリープする時間を示すミリセカンドの値を設定します。
 void setUrl(String v)
          このデータソースがデータベースの位置を認識するためのURLの値を設定します。
 void setUser(String v)
          デフォルトユーザ(ログイン名 または ユーザ名)の値を設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

DriverAdapterCPDS

public DriverAdapterCPDS()
Serialization のための引数のないデフォルトコンストラクタ。

メソッドの詳細

getDescription

public String getDescription()
記述情報(Description)の値を取得します。 このプロパティはこのデータソースをデプロイする処理のために存在し、内部では使用されません。

戻り値:
記述情報(Description)の値

getDriver

public String getDriver()
ドライバのクラス名を取得します。

戻り値:
ドライバの値

getLoginTimeout

public int getLoginTimeout()
このデータソースがデータベースとの接続を試みる場合に待機する最長時間(秒)を取得します。 この実装では使用されません。

定義:
インタフェース ConnectionPoolDataSource 内の getLoginTimeout

getLogWriter

public PrintWriter getLogWriter()
このデータソースのログライターを取得します。この実装では使用されません。

定義:
インタフェース ConnectionPoolDataSource 内の getLogWriter

getMaxActive

public int getMaxActive()
このプールから1度に割り当てることのできるアクティブなステートメントの最大数です。 0が設定された場合には制限を行いません。


getMaxIdle

public int getMaxIdle()
余分なものを開放せずにプール内にアイドル状態で保持できるステートメントの最大数です。 0が設定された場合には制限を行いません。


getMinEvictableIdleTimeMillis

public int getMinEvictableIdleTimeMillis()
アイドル状態のオブジェクトがプール内に居られる最短時間を返します。 この時間を過ぎるとアイドル状態のオブジェクトを排除するスレッドのチェック対象となります。 *see #setMinEvictableIdleTimeMillis *see #setTimeBetweenEvictionRunsMillis


getNumTestsPerEvictionRun

public int getNumTestsPerEvictionRun()
アイドル状態のオブジェクトを排除するスレッドが1度の動作でチェックの対象とするステートメントの数を返します。 *see #setNumTestsPerEvictionRun *see #setTimeBetweenEvictionRunsMillis


getObjectInstance

public Object getObjectInstance(Object refObj,
                                Name name,
                                Context context,
                                Hashtable env)
                         throws Exception
このクラスのインスタンスを生成するための ObjectFactory の実装です。

定義:
インタフェース ObjectFactory 内の getObjectInstance
例外:
Exception

getPassword

public String getPassword()
デフォルトユーザのパスワードの値を取得します。

戻り値:
パスワードの値

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException
デフォルトのユーザ、パスワードを使用してデータベースへの接続の確立を試みます。

定義:
インタフェース ConnectionPoolDataSource 内の getPooledConnection
例外:
SQLException

getPooledConnection

public PooledConnection getPooledConnection(String username,
                                            String password)
                                     throws SQLException
データベースへの接続の確立を試みます。

定義:
インタフェース ConnectionPoolDataSource 内の getPooledConnection
例外:
SQLException

getReference

public Reference getReference()
                       throws NamingException
Referenceable の実装です。

定義:
インタフェース Referenceable 内の getReference
例外:
NamingException

getTimeBetweenEvictionRunsMillis

public int getTimeBetweenEvictionRunsMillis()
アイドル状態のオブジェクトを排除するスレッドが次の動作までスリープする時間を示すミリセカンドの値を返します。 マイナスの値が設定されている場合、アイドル状態のオブジェクトを排除するスレッドは動作しません。 *see #setTimeBetweenEvictionRunsMillis


getUrl

public String getUrl()
このデータソースがデータベースの位置を認識するためのURLの値を取得します。

戻り値:
URLの値

getUser

public String getUser()
デフォルトユーザ(ログイン名 または ユーザ名)の値を取得します。

戻り値:
ユーザの値

isPoolPreparedStatements

public boolean isPoolPreparedStatements()
PreparedStatement のプーリング機能の切り替えフラグです。

戻り値:
poolPreparedStatements の値

setDescription

public void setDescription(String v)
記述情報(Description)の値を設定します。 このプロパティはこのデータソースをデプロイする処理のために存在し、内部では使用されません。

パラメータ:
v - 記述情報(Description)に割り当てる値

setDriver

public void setDriver(String v)
               throws ClassNotFoundException
ドライバのクラス名を設定します。 ドライバクラス名の設定は DriverManager に登録されたドライバに影響します。

パラメータ:
v - ドライバに割り当てる値
例外:
ClassNotFoundException

setLoginTimeout

public void setLoginTimeout(int seconds)
このデータソースがデータベースとの接続を試みる場合に待機する最長時間(秒)を設定します。 この実装では使用されません。

定義:
インタフェース ConnectionPoolDataSource 内の setLoginTimeout

setLogWriter

public void setLogWriter(PrintWriter out)
このデータソースのログライターを設定します。この実装では使用されません。

定義:
インタフェース ConnectionPoolDataSource 内の setLogWriter

setMaxActive

public void setMaxActive(int maxActive)
このプールから1度に割り当てることのできるアクティブなステートメントの最大数です。 0が設定された場合には制限を行いません。


setMaxIdle

public void setMaxIdle(int maxIdle)
余分なものを開放せずにプール内にアイドル状態で保持できるステートメントの最大数です。 0が設定された場合には制限を行いません。


setMinEvictableIdleTimeMillis

public void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis)
アイドル状態のオブジェクトがプール内に居られる最短時間を設定します。 この時間を過ぎるとアイドル状態のオブジェクトを排除するスレッドのチェック対象となります。 マイナスの値が設定された場合、アイドル状態で居た時間ではオブジェクトはプールから排除されません。 *see #getMinEvictableIdleTimeMillis *see #setTimeBetweenEvictionRunsMillis


setNumTestsPerEvictionRun

public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
アイドル状態のオブジェクトを排除するスレッドが1度の動作でチェックの対象とするステートメントの数を返します。

マイナスの値が設定された場合、ceil({*link #numIdle})/abs({*link #getNumTestsPerEvictionRun}) の数のテストが実施されます。 例えば値が -n の場合にはアイドル状態のステートメントのうち 1/n が1度の動作でテストされます。 )/abs({*link #getNumTestsPerEvictionRun}) tests will be run. I.e., when the value is -n, roughly one nth of the idle objects will be tested per run.} *see #getNumTestsPerEvictionRun *see #setTimeBetweenEvictionRunsMillis


setPassword

public void setPassword(String v)
デフォルトユーザのパスワードの値を設定します。

パラメータ:
v - パスワードに割り当てる値

setPoolPreparedStatements

public void setPoolPreparedStatements(boolean v)
PreparedStatement のプーリング機能の切り替えフラグです。

パラメータ:
v - true の場合、ステートメントをプールします。

setTimeBetweenEvictionRunsMillis

public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis)
アイドル状態のオブジェクトを排除するスレッドが次の動作までスリープする時間を示すミリセカンドの値を設定します。 マイナスの値が設定されている場合、アイドル状態のオブジェクトを排除するスレッドは動作しません。 *see #getTimeBetweenEvictionRunsMillis


setUrl

public void setUrl(String v)
このデータソースがデータベースの位置を認識するためのURLの値を設定します。

パラメータ:
v - URLに割り当てる値

setUser

public void setUser(String v)
デフォルトユーザ(ログイン名 または ユーザ名)の値を設定します。

パラメータ:
v - ユーザに割り当てる値


このドキュメントは、Ja-Jakartaにより訳されました。 コメントがある場合は report@jajakarta.orgまでお願いします。
Translated into Japanese by jajakarta.org. The original page is here.
Copyright (c) 2002-2003 - Apache Software Foundation