エンティティ Bean のライフサイクル

エンティティ Bean を開発するときには、Bean とコンテナの関係を活用して、Bean のコアロジックのコンテキストの外部でロジックと最適化を実行します。コンテナがインスタンスを作成およびプールし、インスタンスにデータを割り当て、Bean メソッドを実行し、最終的にインスタンスを削除するとき、コンテナはコードを実行する機会を提供します。このトピックでは、エンティティ Bean のライフサイクルの概要について説明し、その機会をいくつか示します。

下の図に、エンティティ Bean のライフサイクルを示します。エンティティ Bean には、次の 3 種類の状態があります。

存在しない。この状態では、Bean は単に、存在しません。
プールされた状態。WebLogic Server が初めて起動される際に、いくつかの Bean インスタンスが作成され、プールに入れられます。プールされた状態の Bean インスタンスは特定のデータに関連付けられていません。つまり、データベース内のレコードに対応していません。必要に応じて、Bean インスタンスをプールに追加できます。また、インスタンスの最大数を設定することもできます (詳細については、「@Entity アノテーション」を参照してください)。
準備完了。準備完了状態の Bean インスタンスは特定のデータに関連付けられています。つまり、実際のビジネスオブジェクトのインスタンスを表します。

各種の状態の期間中に利用可能なメソッドの他、さまざまな状態遷移について以下で説明します。

存在しない状態からプールされた状態へ移行する

WebLogic Server は、プール内に Bean インスタンスを作成するときに、コールバックメソッド public void setEntityContext(EntityContext ctx) を呼び出します。このメソッドには、パラメータ javax.ejb.EntityContext が指定されます。このパラメータはエンティティコンテキストへの参照、すなわち EJB コンテナへのインタフェースを含みます。エンティティコンテキストには、そのエンティティ Bean オブジェクトの自己参照や、メソッドの呼び出し側の識別などを行う複数のメソッドが含まれています。javax.ejb.EntityContext の詳細については、お好きな J2EE ドキュメントおよび http://java.sun.com にある API リファレンスを参照してください。

エンティティ Bean で EntityContext 参照を使用する場合は、このコールバックメソッドを実装し、参照を格納する必要があります。さらにこのメソッドは、Bean のメソッドのいずれかでその後に呼び出される他の Bean のホームインタフェースをルックアップするのにもよく使用されます。次のコードは、この両方を示します。

@LocalRefs({
    @LocalRef(link="Recording") 
}) 
abstract public class BandBean extends GenericEntityBean implements EntityBean
{
    private EntityContext ctx;
    private RecordingHome recordingHome;

    public void setEntityContext(EntityContext c) {

    // EntityContext への参照を格納する
    ctx = c;

    // RecordingBean のホーム インタフェースをルックアップする
    try {
        javax.naming.Context ic = new InitialContext();
        recordingHome = (RecordingHome)ic.lookup("java:/comp/env/ejb/Recording"); 
    }
    catch(Exception e) {
        System.out.println("Unable to obtain RecordingHome: " + e.getMessage());
    }
}

プールされた状態

Bean インスタンスは、プールされた状態にある場合には、特定のビジネスオブジェクトに関連付けられていません。プールされた状態では、プールされた状態から準備完了状態への実質的な移行を行う、ホームインタフェースで定義されたメソッド (ejbHome メソッドを除く) を呼び出すことができます。ホームメソッドが呼び出されると、Bean インスタンスに固有でない結果が呼び出し側に返され、Bean インスタンスはプールされた状態のままになります。ホームメソッドは代わりに ejbSelect メソッドを頻繁に呼び出して Bean インスタンスをクエリします。

プールされた状態から準備完了状態へ移行する

以下のメソッドは、ビジネスオブジェクトを表すために Bean インスタンスをプールされた状態から準備完了状態へ移行します。

ejbCreate および ejbPostCreate。Bean のホームインタフェースで作成メソッドが呼び出される場合、ejbCreate メソッドおよび ejbPostCreate メソッドが呼び出されます。Bean インスタンスは、準備完了状態に移行し、この新しく作成されたビジネスオブジェクトを表します。作成後、このオブジェクトへの (ローカルまたはリモート) 参照が呼び出し側に返され、呼び出し側はこのインスタンスでビジネスメソッドを呼び出すことができるようになります。ejbPostCreate メソッドは、新しい Bean インスタンスの作成の一部として、他のエンティティ Bean への参照を設定する場合に使用されます。詳細については、「エンティティ Bean の関係」を参照してください。
findByPrimaryKey。Bean のホームインタフェースで、パラメータとして (複合) 主キーを持つこのメソッドが呼び出されると、Bean インスタンスは準備完了状態へ移行し、パラメータによってユニークに識別されるビジネスオブジェクトを表します。また、このオブジェクトへの (ローカルまたはリモート) 参照が呼び出し側に返され、呼び出し側はこのインスタンスでビジネスメソッドを呼び出すことができるようになります。
find メソッド。Bean のホームインタフェースで find メソッドが呼び出されると、クエリに一致するオブジェクトへの単一の参照または一連の参照が呼び出し側に返されます。多くの場合、対応する Bean インスタンスは、後でビジネスメソッドが実際にこのオブジェクトで呼び出される時点まで、データと共にロードされず、準備完了状態に移行しません。これは怠惰なロードと呼ばれる概念です。ただし、積極的なロードを指定することもできます。つまり、EJB コンテナにデータ (の一部) をロードし、エンティティ Bean インスタンスをファインダメソッド例外の一部として準備完了状態に移行するよう指示できます。

準備完了状態

Bean インスタンスは、準備完了状態にある場合には、ビジネスオブジェクトのデータを表します。この時点では、ビジネスメソッド (つまり、コンポーネントメソッドおよびアクセサメソッド) をこのオブジェクトで呼び出すことができます (コンポーネントメソッドは代わりに ejbSelect メソッドを呼び出す場合もあります)。ビジネスメソッドが実行されると、Bean は準備完了状態に戻り、別のビジネスメソッド呼び出しを許可します。

EJB コンテナから見ると、コンポーネントメソッドの実行は、以下の 2 つの同期化手順の間に挟まれています。

ビジネスメソッドが実行される前に、EJB コンテナは Bean インスタンスのフィールドをデータベーステーブルからの最新のデータで更新し、Bean インスタンスに確実に最新のデータがあるようにします。データが更新されるとすぐに、EJB コンテナはコールバックメソッド ejbLoad を呼び出します。エンティティ Bean がこの同期化手順の一部として何らかのカスタムロジックの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。
ビジネスメソッドが実行され、完了します。
EJB コンテナは、データベーステーブルを更新し、確実にエンティティ Bean インスタンスからの最新のデータが格納されるようにします。つまり、ビジネスメソッドがデータ値を更新すると、この同期化手順によってそれらの変更が確実に格納されます。データベーステーブルが更新される直前に、EJB コンテナはコールバックメソッド ejbStore を呼び出します。エンティティ Bean がこの同期化手順の一部として何らかのカスタムロジックの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。

データベーステーブル内のデータは複数の Bean インスタンスによる同時アクセスが可能なので、これらの同期化手順によって、各 Bean インスタンスに常に最新のデータがあることが保証されます。ただし、過剰な同期化手順によって不必要にパフォーマンスが低下する場合もあります。たとえば、エンティティ Bean が読み取り専用であり、めったに変更されないデータを読み込む場合があるとします。こうした場合、データの整合性違反の危険を冒すことなく、同期化手順を安全に回避できます。

準備完了状態からプールされた状態へ移行する

呼び出し側が remove メソッドを呼び出して、エンティティ Bean インスタンスとデータベーステーブルのその基底のレコードを削除する場合、EJB コンテナによって Bean インスタンスが削除されます。インスタンス削除の直前、EJB コンテナはコールバックメソッド ejbRemove を呼び出します。エンティティ Bean が、削除の前に何らかのカスタムロジックの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。データが削除されると、Bean インスタンスはプールされた状態に戻ります。Bean インスタンスは、特定のビジネスオブジェクトに関連付けられなくなり、ホームメソッド、またはそのインスタンスを一連の新しいデータに関連付けて準備完了状態に移行するメソッドのいずれかを実行するのに使用されます。

エンティティ Bean インスタンスを削除する方法の詳細については、「エンティティ Bean インスタンスの削除」を参照してください。

アクティブ化とパッシベーション

より最適にリソースを管理するため、EJB コンテナは Bean インスタンスを準備完了状態からプールされた状態に移行させることによる、パッシベーションを行うことがあります。パッシベーション時には、エンティティ Bean インスタンスは、それが表すビジネスオブジェクトとの関連付けが解除され、別の一連のデータを表すために使用できるようになります。逆に、パッシベーションされた Bean がアクティブ化される、つまり、ビジネスオブジェクトを表すためにプールされた状態から準備完了状態へ移行する場合もあります。

エンティティ Bean インスタンスの呼び出し側 (クライアントアプリケーションまたは別の EJB) には、パッシベーションが行われたことは伝わりません。エンティティ Bean インスタンスへの呼び出し側の参照は、引き続き保持されており有効です。つまり、呼び出し側がその後エンティティ Bean インスタンスでビジネスメソッドを呼び出すと、プールされた状態のインスタンスはこのビジネスオブジェクトを表すために準備完了状態に移行されます。

Bean インスタンスは、そのビジネスメソッドがまったく呼び出されないときにパッシベーションされます。パッシベーションは同期が完了した後に発生し、ビジネスオブジェクトに対するすべての変更がデータベースに格納されていることを保証します。実際のパッシベーションの直前に、コールバックメソッド ejbPassivate が呼び出されます。エンティティ Bean が、パッシベーションの前に何らかのカスタムロジックの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。

以前にパッシベーションが行われた Bean インスタンスがビジネスメソッド呼び出しを行うためにアクティブ化される場合は、コールバックメソッド ejbActivate が呼び出されます。エンティティ Bean が、アクティブ化の前に何らかのカスタムロジックの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。たとえば、このコールバックメソッドを使用して非永続のフィールド (データベースに格納されていないフィールド) の値を再初期化する場合があるとします。コールバックメソッドが実行され完了すると、先述の節で説明した「同期 - ビジネスメソッド呼び出し - 同期」という手順が、他のビジネスメソッド呼び出し時と同じように続きます。つまり、最初の同期が発生し、最新の Bean インスタンスがデータベースの最新のデータで更新され、続いて ejbLoad コールバックメソッドが呼び出されます。ビジネスメソッドの呼び出しが完了した後、ビジネスメソッドが完了すると、2 番目の同期が発生します。そのとき、ejbStore コールバックメソッドが呼び出され、最新の Bean インスタンスのデータがデータベースに格納されます。

プールされた状態から存在しない状態へ移行する

より最適にリソースを管理するために、または WebLogic Server の停止時に、EJB コンテナは、ガベージコレクションを可能にして Bean インスタンスをプールされた状態から存在しない状態へ削除することがあります。破棄の直前に、コールバックメソッド unsetEntityContext が呼び出されます。エンティティ Bean が、ガベージコレクションの前に何らかのクリーンアップアクションの実行を必要とする場合は、このコールバックメソッドを使用して実装できます。