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

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

BaseKeyedPoolableObjectFactory

public interface KeyedPoolableObjectFactory

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

An interface defining life-cycle methods for instances to be served by a {@link KeyedObjectPool KeyedObjectPool}.

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

By contract, when an {@link KeyedObjectPool KeyedObjectPool} delegates to a KeyedPoolableObjectFactory,

1. 新たなインスタンスが必要となった場合 makeObject が呼ばれます。
   {@link #makeObject makeObject} is called whenever a new instance is needed.
2. プールからインスタンスが渡される前には activateObject が実施されます。
   {@link #activateObject activateObject} is invoked on every instance before it is returned from the pool.
3. プールにインスタンスが戻されると passivateObject が実施されます。
   {@link #passivateObject passivateObject} is invoked on every instance when it is returned to the pool.
4. ( validateObject の結果またはプールの実装に指定された理由によって) プールからインスタンスが取り除かれる場合には destroyObject が実施されます。
   {@link #destroyObject destroyObject} is invoked on every instance when it is being "dropped" from the pool (whether due to the response from {@link #validateObject validateObject}, or for reasons specific to the pool implementation.)
5. 各実装がプール内のインスタンスが有効な状態かどうか判断するための方法として validateObject が実施されます。 これは "activated" なインスタンスに対してのみ行われます。
   {@link #validateObject validateObject} is invoked in an implementation-specific fashion to determine if an instance is still valid to be returned by the pool. It will only be invoked on an {@link #activateObject "activated"} instance.

バージョン:

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

作成者:

Rodney Waldhoff

関連項目:

KeyedObjectPool

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2004/02/21

メソッドの概要

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

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

Reinitialize an instance to be returned by the pool.

パラメータ:

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

the key used when selecting the object

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

the instance to be activated

例外:

Exception

destroyObject

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

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

Destroys an instance no longer needed by the pool.

パラメータ:

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

the key used when selecting the instance

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

the instance to be destroyed

例外:

Exception

makeObject

public Object makeObject(Object key)
                  throws Exception

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

Create an instance that can be served by the pool.

パラメータ:

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

the key used when constructing the object

戻り値:

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

instance that can be served by the pool.

例外:

Exception

passivateObject

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

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

Uninitialize an instance to be returned to the pool.

パラメータ:

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

the key used when selecting the object

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

the instance to be passivated

例外:

Exception

validateObject

public boolean validateObject(Object key,
                              Object obj)

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

Ensures that the instance is safe to be returned by the pool. Returns false if this object should be destroyed.

パラメータ:

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

the key used when selecting the object

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

the instance to be validated

戻り値:

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

false if this obj is not valid and should be dropped from the pool, true otherwise.