org.apache.commons.pool
インタフェース KeyedPoolableObjectFactory

既知の実装クラスの一覧:

BaseKeyedPoolableObjectFactory

public interface KeyedPoolableObjectFactory

KeyedObjectPool に保持されるインスタンスの ライフサイクルに関するメソッドを定義したインターフェイスです。

KeyedObjectPool を生成する際に KeyedPoolableObjectFactory が指定され、以下の処理が行われます。

1. 新たなインスタンスが必要となった場合 makeObject が呼ばれます。
2. プールからインスタンスが渡される前には activateObject が実施されます。
3. プールにインスタンスが戻されると passivateObject が実施されます。
4. ( validateObject の結果またはプールの実装に指定された理由によって) プールからインスタンスが取り除かれる場合には destroyObject が実施されます。
5. 各実装がプール内のインスタンスが有効な状態かどうか判断するための方法として validateObject が実施されます。 これは "activated" なインスタンスに対してのみ行われます。

バージョン:

$Revision: 1.1 $ $Date: 2004/02/22 11:58:26 $

作成者:

Rodney Waldhoff

関連項目:

KeyedObjectPool

翻訳者:

日置 聡

メソッドの概要

void	activateObject(Object key, Object obj) プールから取り出されるインスタンスの初期化を行います。
void	destroyObject(Object key, Object obj) プールで必要のなくなったインスタンスを破棄します。
Object	makeObject(Object key) プールに保持されるインスタンスを生成します。
void	passivateObject(Object key, Object obj) プールに戻されたインスタンスの後処理を行います。
boolean	validateObject(Object key, Object obj) このインスタンスがプールにて安全に使用できるかを判断します。

メソッドの詳細

activateObject

public void activateObject(Object key,
                           Object obj)
                    throws Exception

プールから取り出されるインスタンスの初期化を行います。

パラメータ:

key - オブジェクトを選択する際に使用されるキー

obj - プールから取り出されるインスタンス

例外:

Exception

destroyObject

public void destroyObject(Object key,
                          Object obj)
                   throws Exception

プールで必要のなくなったインスタンスを破棄します。

パラメータ:

key - インスタンスを選択する際に使用されるキー

obj - 破棄されるインスタンス

例外:

Exception

makeObject

public Object makeObject(Object key)
                  throws Exception

プールに保持されるインスタンスを生成します。

パラメータ:

key - オブジェクトを生成する際に使用されるキー

戻り値:

プールに保持されるインスタンス

例外:

Exception

passivateObject

public void passivateObject(Object key,
                            Object obj)
                     throws Exception

プールに戻されたインスタンスの後処理を行います。

パラメータ:

key - オブジェクトを選択する際に使用されるキー

obj - プールに戻されたインスタンス

例外:

Exception

validateObject

public boolean validateObject(Object key,
                              Object obj)

このインスタンスがプールにて安全に使用できるかを判断します。 このオブジェクトを破棄するべき場合には false を返します。

パラメータ:

key - オブジェクトを選択する際に使用されるキー

obj - チェックを行うインスタンス

戻り値:

obj が無効でプールから削除すべき場合 false、 それ以外の場合 true