ヘッダーをスキップ
Oracle Fusion Middleware Oracle Application Development Framework Fusion開発者ガイド
11gリリース1 (11.1.1.7.0)
B52028-05
  目次へ移動
目次

前
 
次
 

21 Fusionページ・ライフサイクル

この章では、ADFページ・ライフサイクルとそのフェーズ、Fusion Webアプリケーション内でのライフサイクルの最適な使用方法について説明します。

この章の内容は次のとおりです。

21.1 Fusionページ・ライフサイクルの概要

ページが送信され、新しいページがリクエストされると、標準のJSFリクエスト・ライフサイクルを拡張するADF Facesページ・ライフサイクル、およびADFページ・ライフサイクルの両方がアプリケーションによって起動されます。拡張JSFライフサイクルは、ページ上の値の送信、コンポーネント値の検証、ページのナビゲート、結果ページへのコンポーネントの表示、および状態の保存とリストアを処理します。JSFライフサイクル・フェーズでは、UIコンポーネント・ツリーを使用してfacesコンポーネントの表示を管理します。このツリーはJSFページのランタイム表現で、ページ内の各UIコンポーネント・タグがツリーのUIコンポーネント・インスタンスに対応します。JSFアプリケーションのリクエスト処理ライフサイクルは、FacesServletサーブレットによって管理されます。FacesServletは、リクエスト処理に必要な情報を含むFacesContextと呼ばれるオブジェクトを作成し、ライフサイクルを実行するオブジェクトを起動します。拡張JSFライフサイクルの詳細は、『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』の「JSFおよびADF Facesのライフサイクルの理解」を参照してください。

ADFページ・ライフサイクルは、データ・モデルの準備と更新、モデル・レイヤーでのデータの検証、ビジネス・レイヤーでのメソッドの実行を処理します。ADFページ・ライフサイクルでは、バインディング・コンテナを使用して、現在のページ・リクエスト時にページによる簡単なデータ参照を可能にします。

組み合せたJSFページ・ライフサイクルとADFページ・ライフサイクルは、アプリケーション・サーバーにHTTPリクエストが届いたときに始まってページがクライアントに戻されるまで続く、より大規模なイベント・シーケンスに含まれる1つのシーケンスにすぎません。このイベント・シーケンス全体をWebページ・ライフサイクルと呼びます。このライフサイクルは、MVCアーキテクチャで定義されているようにモデル、ビュー、コントローラのレイヤーを通して処理をたどっていきます。ページ・ライフサイクルは厳格に定義されたイベント・セットではなく、一般的なユースケースで使用されるイベント・セットです。図21-1に、JSFとOracle ADFを併用した場合のWebページ・リクエストのライフサイクルのシーケンス図を示します。

図21-1 JSFおよびOracle ADFを使用したWebページ・リクエストのライフサイクル

ADFアプリケーションでの制御フロー

JSFおよびOracle ADFを使用したWebページ・リクエストの処理の基本的なフローは、次のようになります。

  1. http://yourserver/yourapp/faces/some.jspに対するWebリクエストが、クライアントからアプリケーション・サーバーに到着します。

  2. ADFBindingFilterオブジェクトが、HTTPセッション内でADFバインディング・コンテキストを検索し、それがまだ存在しない場合はその初期化を初めて実行します。ADFBindingFilterの機能には、バインディング・コンテキスト・メタデータ・ファイルの名前の検索、各データ・コントロールの検索と構築などがあります。

  3. ADFBindingFilterオブジェクトが、該当するリクエストに関与する各データ・コントロールに対してbeginRequest()メソッドを起動します。このメソッドにより、データ・コントロールは各リクエストの開始時に通知を受けるため、必要な設定を実行できるようになります。

  4. JSF Lifecycleオブジェクト(各リクエストの標準的な処理フェーズの調整を行う)が、ライフサイクルの各フェーズでADFPhaseListenerクラスに通知し、JSFライフサイクルとADFモデル・データ・バインディング・レイヤーを調整するためのカスタムな処理が実行できるようにします。JSFページ・ライフサイクルとADFページ・ライフサイクルのフェーズの詳細は、21.2項「JSFページ・ライフサイクルとADFページ・ライフサイクル」を参照してください。


    注意:

    FacesServletクラス(javax.faces.webapp内)は、JSFアプリケーションのweb.xmlファイル内で構成され、各リクエストを処理するためのJSF Lifecycleクラス(javax.faces.lifecycle内)を最初に作成します。ただし、FacesServletクラスは、該当する処理をすべて実行するLifecycleクラスであるため、図に示していません。


  5. ADFPhaseListenerオブジェクトが、各リクエストを処理するためのADF PageLifecycleオブジェクトを作成し、該当するフェーズ前およびフェーズ後のメソッドをADF PageLifecycleクラス内の対応するメソッドに委譲します。ページのバインディング・コンテナは、該当ユーザーのセッション中、以前に適切なものが使用されていない場合、作成されます。

  6. アプリケーション・モジュール・データ・コントロールが、リクエスト時に初めて参照されると、アプリケーション・モジュール・プールからアプリケーション・モジュールのインスタンスを取得します。

  7. JSF Lifecycleオブジェクトが、レンダリング対象のページにコントロールを移動します。

  8. 該当するページ上の一連のUIコンポーネントが、該当ページのバインディング・コンテナ内の値バインディングおよびイテレータ・バインディングにアクセスし、フォーマット設定された出力をレンダリングしてブラウザに表示します。

  9. ADFBindingFilterオブジェクトが、該当するリクエストに関与する各データ・コントロールに対してendRequest()メソッドを起動します。このメソッドにより、データ・コントロールは各リクエストの終了時に通知を受けるため、必要なリソースのクリーンアップを実行できるようになります。

  10. アプリケーション・モジュール・データ・コントロールがendRequestの通知を使用して、アプリケーション・モジュール・プールにアプリケーション・モジュールのインスタンスを解放して戻します。

  11. 得られたページが、ユーザーのブラウザに表示されます。

ADFページ・ライフサイクルには、対応するJSFフェーズの実行前後にADFページ・ライフサイクル・リスナーに通知するためのみに定義されたフェーズも含まれています(これらのフェーズは実装されていません)。これらのフェーズにより、カスタム・リスナーを作成してJSFページ・ライフサイクルとADFページ・ライフサイクルの両方のフェーズに登録できるため、必要に応じてグローバルに、またはページ・レベルでADFページ・ライフサイクルをカスタマイズできるようになります。

21.2 JSFページ・ライフサイクルとADFページ・ライフサイクル

図21-2は、JSFおよびADFのフェーズがページ・リクエストのライフサイクルの中でどのように統合されるかを示しています。JSFライフサイクルが単独でどのように動作するかの詳細は、『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』の「JSFおよびADF Facesのライフサイクルの理解」を参照してください。

図21-2 Fusion Webアプリケーションでのページ・リクエストのライフサイクル

ADFおよびJSFのフェーズの連携

ADFモデル・レイヤーを使用するJSFアプリケーションでは、ページ・ライフサイクルのフェーズは次のようになります。

21.2.1 Refreshプロパティの正しい使用について

スケーラビリティ上の理由から、バインディング・コンテナ内のイテレータ・バインディングは、実行時に、行セット・イテレータへの参照を各リクエストの終了時に解放します。次のリクエスト中に、各イテレータ・バインディングにより、データ・コレクションの現在の行を追跡している有効な行セット・イテレータへのそれぞれの再バインドが行われます。ADFページ・ライフサイクルの中でADFイテレータ・バインディングを再バインドする処理は、イテレータのリフレッシュと呼ばれます。デフォルトでは、ライフサイクルの中でクライアント・レイヤーが初めてイテレータにアクセスしたときの1回のみ、必要に応じて発生します。この、イテレータへの初回のアクセスは、ページのレンダリング処理の中で、そのイテレータまたはイテレータに関係するコントロール・バインディングを参照するページ内のEL式が評価される際に発生します。もしくは、コードを記述して、イテレータへの初回のアクセスがレンダリングの準備フェーズの前に発生するようにプログラミングできます。イテレータ・バインディングによる行セット・イテレータのリフレッシュを、ライフサイクルのより早い段階で強制的に発生させるには、イテレータ・バインディングのrefresh属性をデフォルト以外の値に設定します。


ヒント:

イテレータ・バインディングがリフレッシュされるたびに、問合せが強制的に再実行されることはありません。特定のユーザーのセッション中にビュー・オブジェクト・インスタンスの行セット・イテレータが初めてアクセスされる際、そのビュー・オブジェクトの問合せがまだ実行されていない場合には、問合せが暗黙的に実行されます(ただし、問合せの実行前にユーザーが検索条件を入力できるようにするための準備として、そのイテレータに関係するページ定義内の検索バインディングにより、その行セットが消去されていない場合にかぎられます)。

同じ論理作業ユニットの一部であるページ・リクエストでそのビュー・オブジェクト・インスタンスに関連するイテレータ・バインディングをこの後でリフレッシュすると、行セット・イテレータへの再アクセスのみが行われ、問合せの再実行は強制されません。問合せを再実行してそのデータをリフレッシュするには、ExecuteまたはExecuteWithParamsという組込み操作を使用するか、イテレータ・バインディングでexecuteQuery()メソッドをプログラムによってコールします。


refreshおよびrefreshCondition属性は、イテレータ・バインディングなどの実行可能ファイルとinvokeActionのどちらをどのタイミングで起動するかを決めるために使用します。refresh属性の値によって、実行可能ファイルを起動するライフサイクル・フェーズが決定し、refreshCondition属性の値によって提供されるオプションのブール条件の結果で、指定のライフサイクル・フェーズでリフレッシュが発生するかどうかが決まります。デフォルトでは、(操作の1つをコマンド・コンポーネントとしてドロップするなどして)ページ定義に実行可能ファイルが追加されると、その実行可能バインディングのrefresh属性が、バインディングへの初回アクセス時には常に実行を強制するdeferredに設定されます。refreshCondition値が存在しない場合は、実行可能ファイルが起動します。refreshConditionの値が存在する場合は、値がEL式として評価され、評価の戻り値がtrueの場合は、実行可能ファイルが起動します。値がfalseと評価された場合は、実行可能ファイルは起動しません。refresh属性の詳細は、A.8.1項「PageDef.xmlの構文」を参照してください。

Fusion Webアプリケーションでは、イテレータ・バインディングのrefreshまたはrefreshConditionの値の変更が必要になることはほとんどありません。これらの値は、正しいデータが確実に表示されるようにするために設定します。invokeActionに対してもこれらの値を変更する必要はありません。通常、ページがレンダリングされる前になんらかのアプリケーション動作を実行するアクション・バインディング(またはバッキングBeanメソッド)をコールするために、タスク・フロー内でメソッド・アクティビティを使用します。たとえば、オブジェクトの作成に使用するページには、CreateInsert操作をコールするメソッド・アクティビティで始まるタスク・フローを使用できます。そのタスク・フローは次に、ユーザーがデータを入力するページのビュー・アクティビティに進みます。この動作を適切なメソッド・コール・アクティビティとしてモデル化すると、アプリケーションが自己文書化される上に管理しやすくなり、アプリケーション・ロジックとデータバインディングがより明確に分離されます。詳細は、22.6項「入力フォームの作成」を参照してください。

ただし、完全性を期すために、イテレータ・バインディングまたはinvokeActionrefresh属性を変更する状況が発生した場合は(たとえば、モデルの準備フェーズ後に実行されるプログラム・コードがあり、イテレータにプログラムでアクセスする必要がある場合)、有効な値に関する次の情報を確認した上で、変更を行う必要があります。

  • deferred (デフォルト): 要求時


    ヒント:

    ページ定義ファイルのinvokeAction実行可能ファイルのrefresh属性の値はデフォルト(deferred)以外である必要があります。デフォルト値では、リフレッシュおよび起動されません。


  • prepareModel: モデルの準備フェーズ中。

  • renderModel: レンダリングの準備フェーズ中。


    ヒント:

    図21-2からわかるとおり、モデルの準備フェーズとレンダリングの準備フェーズの主な違いは、一方がJSFのアプリケーションの起動フェーズの前にあり、他方が後にあることです。JSFのアプリケーション起動フェーズではアクション・リスナーが起動されるため、これらのアクション・リスナーによってそれぞれの処理が実行された後に、イテレータのリフレッシュ、またはinvokeActionに関連付けられたメソッドや操作の実行が必要な場合は、refresh属性をrenderModelに設定します。


  • ifNeeded: モデルの準備フェーズおよびレンダリングの準備フェーズ中(必要な場合のみ)。イテレータに関しては、バインディングがまだリフレッシュされていない場合に、リフレッシュが必要であるとみなされます。invokeActionの実行が必要かどうかを判断するため、フレームワークは、評価されたパラメータ値の現在のセットを、前回のメソッド・アクション・バインディングの起動に使用されたセットと比較します。また、起動されたメソッドの結果をキャッシュされた結果と比較します。現在の起動に対するパラメータ値または戻り値(あるいはその両方)が前回使用した値と完全に同じ場合、invokeActionは、バインドされているメソッド・アクション・バインディングを起動しません。この設定を使用して、invokeAction実行可能ファイルがパラメータを受け入れるメソッド・アクション・バインディングにバインドされるかどうかを判断します。


    ヒント:

    パラメータを取らないメソッドにバインドされているinvokeAction実行可能ファイルについては、invokeAction実行可能ファイルは2回コールされます。パラメータを使用しないメソッドとともにinvokeAction実行可能ファイルを使用する場合は、refreshCondition属性に関連付けられている条件によるメソッドの評価および起動が、値が変更された場合のみ行われるようにする必要があります。これで、複数回起動されることはなくなります。


  • prepareModelIfNeededおよびrenderModelIfNeeded: ifNeededと同様ですが、名前付きフェーズ中に実行されます。

  • never: invokeAction実行可能ファイルでは無効です。イテレータの場合、イテレータがリフレッシュされることはありません。独自のコードがイテレータ・バインディングでgetRowSetIterator()をコールする場合に使用します。

  • always: invokeAction実行可能ファイルでは無効です。イテレータの場合、イテレータは常に、モデルの更新フェーズ中に加えて、モデルの準備とレンダリングの準備の両フェーズ中にリフレッシュされます(複数回の場合もあります)。

  • refreshAfter: 実行可能ファイル間の依存性の処理に使用します。たとえば、別の実行可能ファイルの後にこの実行可能ファイルがリフレッシュされるように条件を設定できます。


    ヒント:

    実行可能ファイルの起動順序は、refreshAfter属性を使用して決定できます。たとえば、2つのinvokeAction要素があり、一方のIDはmyAction、他方のIDはanotherActionで、anotherActionの後にmyActionを起動するとします。myActionrefreshAfter条件をanotherActionに設定します。


21.2.2 タスク・フローとライフサイクルについて

タスク・フローは、(ページに関連付けられている)親バインディング・コンテナのリフレッシュ時に初めてリフレッシュされます。これはモデルの準備フェーズで発生します。後続のリクエストでは、レンダリングの準備フェーズにおいて、refreshおよびrefreshCondition属性とそのパラメータ値に基づいてタスク・フローがリフレッシュされます。


注意:

子ページ・フラグメントのページ定義は、引き続き子ページ・フラグメントのバインディングのリフレッシュを処理します。



ヒント:

最初は公開されないリージョン(ポップアップ・ダイアログなど)がページ上にある場合、リージョンが表示されなくても、親ページのレンダリング時にパラメータは使用可能である必要があります。リージョンにパラメータが必要であるにもかかわらず、これらのパラメータ値を親ページのレンダリング時に使用できない場合は、動的リージョンを使用する必要があります。パラメータがNULLの場合、リージョンのパラメータの準備が完了してリージョンを表示できるようになるまで、空のタスク・フローを使用できます。空のタスク・フローに切り替えるには、動的リージョンのtaskFlowId属性を空の文字列に設定します。


EL式をrefreshCondition属性の値として設定した場合、ライフサイクルのレンダリングの準備フェーズ中に評価されます。式がtrueに評価されると、タスク・フローは再度リフレッシュされます。refreshConditionfalseに評価されると、refreshConditionが指定されていない場合と動作は同じです。


注意:

EL式でbindings変数が使用されていると、リージョン内に表示されるページ・フラグメントではなく、親ページのバインディング・コンテナが参照されます。


タスク・フロー実行可能ファイルのrefreshプロパティの有効な値は次のとおりです。

  • default: 親ページが最初に表示されるときに、リージョンは1回のみリフレッシュされます。

  • ifNeeded: taskFlowバインディングのパラメータ値に変更があった場合のみ、リージョンがリフレッシュされます。taskFlowバインディングにパラメータがない場合、ifNeededはデフォルトと同じです。ifNeededを使用した場合、refreshCondition属性は考慮されません。


    注意:

    refresh属性をifNeededに設定した場合は、refreshCondition属性のいずれの値よりも優先されます。また、動的パラメータMapを使用してtaskFlowバインディングにパラメータを渡す場合、ifNeededはサポートされません。その場合は、refreshCondition="#{EL.Expression}"を使用します。


taskFlowバインディングによる唯一の処理はそのパラメータのリフレッシュであり、Refreshalwaysに設定する意味はありません。taskFlowバインディングのパラメータが変更されないかぎり、ADFリージョンをリフレッシュする理由はありません。

子ページ・フラグメントのページ定義は、引き続き子ページ・フラグメントのバインディングのリフレッシュを処理します。

21.3 オブジェクト・スコープ・ライフサイクル

実行時には、バインディング・コンテナおよびマネージドBeanなどのADFオブジェクトはインスタンス化されています。これらのオブジェクトにはそれぞれ、そのスコープ属性により設定された存続期間が定義されています。RequestContext APIからjava.util.Mapとしてスコープにアクセスできます。たとえば、リクエスト・スコープのfooというオブジェクトにアクセスするには、式#{requestScope.foo}を使用します。

Fusion Webアプリケーションには次の6種類のスコープがあります。

オブジェクト・スコープは、プログラミング言語におけるグローバル変数スコープおよびローカル変数スコープに類似しています。スコープの幅が広くなるほど、オブジェクトの可用性が高まります。オブジェクトの存続期間中、これらのオブジェクトによってあるインタフェースが公開され、情報が保持され、あるいは変数およびパラメータが他のオブジェクトに渡されます。たとえば、セッション・スコープで定義されたマネージドBeanは、ページ・リクエストが複数存在する場合に使用できます。ただし、リクエスト・スコープで定義されたマネージドBeanは、1つのページ・リクエストが継続する間のみ使用できます。

デフォルトでは、バインディング・コンテナおよびそれに含まれるバインディング・オブジェクトは、セッション・スコープで定義されます。ただし、値バインディングおよびイテレータ・バインディングによって参照されるはリクエスト間で定義されず、スケーラビリティ上の理由により、セッション・スコープに残りません。このため、バインディング・オブジェクトが参照する値は、そのバインディング・コンテナがADFライフサイクルによって準備されているリクエストの間のみ有効です。セッション・スコープには、バインディング・コンテナおよびバインディング・オブジェクト自体のみ残されます。

図21-3に、各タイプのスコープが有効な期間を示します。

図21-3 スコープとページ・フローの関係

ADFライフサイクルにおけるスコープ

マネージドBeanをどのスコープに登録するかを決定するときは常に、できるかぎり狭いスコープを使用するようにします。セッション・スコープは、セッション全体に関連する情報(ユーザー情報やコンテキスト情報など)にのみ使用します。タスク・フロー間で値を渡すためにセッション・スコープを使用しないでください。ページ・フラグメントまたは宣言コンポーネントのマネージドBeanを作成するときは、バッキングBeanスコープを使用する必要があります。

マネージドBeanは、adfc-config.xmlまたは特定のタスク・フローの構成ファイルに登録できます。FusionアプリケーションでのマネージドBeanの使用に関する詳細は、20.4項「Fusion WebアプリケーションでのマネージドBeanの使用」を参照してください。


注意:

Fusion Webアプリケーションでは、faces-config.xmlファイル内でのマネージドBeanの登録はお薦めしません。


21.3.1 オブジェクト・スコープとタスク・フローについて

タスク・フロー内の変数にどのスコープを使用するかを決定するときは、アプリケーション・スコープまたはセッション・スコープ以外のスコープ・オプションを使用する必要があります。これら2つのスコープは、タスク・フローの存続期間を超えてオブジェクトをメモリーに保存するため、タスク・フローのカプセル化および再利用で障害が発生します。さらに、アプリケーション・スコープおよびセッション・スコープでは、オブジェクトがメモリーに必要以上に長い時間保持されるため、不要なオーバーヘッドが発生します。

タスク・フロー内のアクティビティ間でデータ値を渡す必要がある場合は、ページ・フロー・スコープを使用する必要があります。現在のビュー・アクティビティ内でのみ必要とされ、ビュー・アクティビティ間にまたがっていない変数の場合、ビュー・スコープが推奨されます。現在のリクエストより長い期間スコープが存続する必要がない場合には、リクエスト・スコープを使用する必要があります。これは、UIコンポーネント情報の格納に使用する唯一のスコープです。最後に、タスク・フローが同じページの2つのリージョン・コンポーネントまたは宣言コンポーネントに表示される可能性があり、リージョン・インスタンスを分離する場合、タスク・フロー内のマネージドBeanには、バッキングBeanスコープを使用する必要があります。

21.4 ADFページ・ライフサイクルのカスタマイズ

ADFライフサイクルには明確に定義されたフェーズが含まれており、このフェーズによって対応するJSFフェーズの実行前後にADFライフサイクル・リスナーに通知が行われます。このライフサイクルは、必要なコードを起動するカスタム・フェーズ・リスナーを作成した後、これらのフェーズのいずれかで実行されるようにライフサイクルに登録することによってカスタマイズできます。

たとえば、カスタム・コードを実行するカスタム・リスナーを作成した後、それをリクエスト値の適用フェーズの前または後に起動できるように、JSFのリクエスト値の適用フェーズに登録できます。


注意:

1つのアプリケーションでは、複数のフェーズ・リスナー・インスタンスを保持できません。デフォルトでは、最初のADFPhaseListenerインスタンスがMETA-INF/faces-config.xml構成ファイルに登録されます。たとえば、ADFPhaseListenerのカスタマイズされたサブクラスを登録すると、2つ目のインスタンスが作成されます。この場合、直近に登録されたインスタンスのみが使用されます。

警告メッセージ「ADFc: ADFページ・ライフサイクル実装を''新しいリスナーのクラス名''と置換しています。」により、インスタンスがより新しいものに置き換えられたことが通知されます。


21.4.1 カスタム・フェーズ・リスナーの作成方法

カスタム・フェーズ・リスナーを作成するには、PagePhaseListenerインタフェースを実装するリスナー・クラスを作成する必要があります。次に、コードの実行が必要なフェーズの前または後にコードを実行するメソッドを追加します。

例21-1 に、カスタム・フェーズ・リスナーを作成するために変更できるテンプレートを示します。JDeveloperでクラスを作成する方法の詳細は、4.13.1項「カスタム・クラスの生成方法」を参照してください。

例21-1 カスタム・フェーズ・リスナーの例

public class MyPagePhaseListener implements PagePhaseListener
{
   public void afterPhase(PagePhaseEvent event)
   {
      System.out.println("In afterPhase " + event.getPhaseId());
   }
 
 
   public void beforePhase(PagePhaseEvent event)
   {
      System.out.println("In beforePhase " + event.getPhaseId());
   }
}

カスタム・リスナー・クラスを作成したら、クラスを起動する必要があるフェーズに登録する必要があります。アプリケーション全体で使用できるようにグローバルに登録するか、1つのページに対してのみ登録することができます。

21.4.2 リスナーをグローバルに登録する方法

ADFライフサイクルをグローバルにカスタマイズするには、adf-settings.xml構成ファイルを編集してカスタム・フェーズ・リスナーを登録します。adf-settings.xmlファイルは、ADFコントローラなど複数のADFコンポーネントにより共有され、構成情報を格納します。adf-settings.xmlファイルが存在しない場合は、作成する必要があります。詳細は、 『Oracle Fusion Middleware Oracle Application Development Framework Webユーザー・インタフェース開発者ガイド』のadf-settings.xmlでの構成に関する項を参照してください。

adf-settings.xmlにリスナーを登録するには:

  1. META-INFディレクトリのadf-settings.xmlファイルをダブルクリックして開きます。

  2. 「ソース」タブをクリックし、次が表示されるまで下にスクロールします。
    <adfc-controller-config xmlns=
    "http://xmlns.oracle.com/adf/controller/config">

    このエントリが存在しない場合は、これをファイルに追加します。

  3. 例21-2ではイタリックで示されている残りの要素を入力します。

    例21-2 リスナー登録のあるadf-settings.xml構成ファイル

     <?xml version="1.0" encoding="US-ASCII" ?> <adf-config xmlns="http://xmlns.oracle.com/adf/config">
      .
      .
      .
        <adfc-controller-config xmlns="http://xmlns.oracle.com/adf/controller/config">
           <lifecycle>
             <phase-listener>
                <listener-id>MyPagePhaseListener</listener-id>
                <class>mypackage.MyPagePhaseListener</class>        
             </phase-listener>
          </lifecycle>
       </adfc-controller-config> 
      .
      .
      .
    </adf-config>
    
  4. 次の要素の値を入力します。

    • <listener-id>: リスナーの一意の識別子(完全修飾クラス名を使用可能)

    • <class>: リスナーのクラス名

21.4.3 リスナーの順序について

adf-settings.xmlでは複数のフェーズ・リスナーを指定できるほか、これらの相対的なコール順序も任意で指定できます。このファイルに新しいリスナーを登録する際には、次の2つのパラメータを使用して、リスナー・リストでの配置を指定します。

  • beforeIdSet: そのリスナーが、beforeIdSetで指定されているリスナーよりも先にコールされます。

  • afterIdSet: そのリスナーが、afterIdSetで指定されているリスナーよりも後にコールされます。

例21-3に、アプリケーション用に複数のリスナーが登録された構成ファイルの例を示します。

例21-3 複数のリスナー登録のあるadf-settings.xml構成ファイル

<lifecycle>
   <phase-listener>
      <listener-id>MyPhaseListener</listener-id>
      <class>view.myPhaseListener</class>
      <after-id-set>
         <listener-id>ListenerA</listener-id>
         <listener-id>ListenerC</listener-id>
      </after-id-set>
      <before-id-set>
         <listener-id>ListenerB</listener-id>
         <listener-id>ListenerM</listener-id>
         <listener-id>ListenerY</listener-id>
      </before-id-set>
   </phase-listener>
</lifecycle>

例では、MyPhaseListenerは登録されたリスナーであり、リスナーAおよびCの後かつ、リスナーB、MおよびYより先に実行されます。リスナーBの後にMyPhaseListenerを実行するには、リスナーBの<listener-id>要素を<after-id-set>要素の下に移動します。

21.4.4 単一ページのライフサイクル・リスナーの登録方法

単一ページのライフサイクルをカスタマイズするには、ページ定義ファイルでControllerClass属性を設定します。このリスナーが有効なのは、ページ定義によって記述された特定ページのライフサイクルに対してのみです。ページ定義ファイルとFusion Webアプリケーションにおけるその役割の詳細は、12.6項「ページ定義ファイルでの作業」を参照してください。

標準JSFページまたはページ・フラグメントのどちらに対するものかに応じて、異なるコントローラ・クラスを指定します。

単一ページまたはページ・フラグメント用にADFライフサイクルをカスタマイズするには:

  1. アプリケーション・ナビゲータで、ページまたはページ・フラグメントを右クリックし、「ページ定義に移動」を選択します。

  2. 構造ウィンドウで、ページ定義ノードを選択します。

  3. プロパティ・インスペクタでControllerClassフィールドの隣のドロップダウン・メニューをクリックし、「編集」を選択します。

  4. 「階層」をクリックし、ページまたはページ・フラグメントの目的のコントローラ・クラスに移動します。各種ページに使用するコントローラ・クラスを次に示します。

    • 標準JSFページの場合 - oracle.adf.controller.v2.lifecycle.PageControllerを指定

      afterPhase/beforePhaseイベントを受信する必要がある場合は、oracle.adf.controller.v2.lifecycle.PagePhaseListenerを指定します。

    • ページ・フラグメント - 次を指定します。
      oracle.adf.model.RegionController


    ヒント:

    完全修飾クラス名としてページ定義のControllerClass属性の値を指定するか、ControllerClassフィールドに、クラスに直接解決されるEL式を入力できます。

    ControllerClass属性の値にEL式を使用すると、#{YourExpression}が有効なクラスではないことを示す警告が構造ウィンドウに表示される場合があります。この警告は無視しても問題ありません。


21.4.5 ページ・フラグメントのRegionControllerの拡張について

リージョンとして使用されるページ・フラグメント内のバインディングは、RegionControllerインタフェースのrefreshRegionおよびvalidateRegionイベントを介してリフレッシュされます。これらのイベントは、21.4.4項「単一ページのライフサイクル・リスナーの登録方法」の説明に従ってControllerClassフィールドにoracle.adf.model.RegionControllerを指定した場合に使用できます。

例21-4に示すように、refreshRegionイベントを使用して、リージョンがリフレッシュされる前に実行するカスタム・コードを追加できます。たとえば、リージョン内のページ・フラグメントにより使用されるバインディングをリフレッシュして、リフレッシュされたバインディング値が内部バインディング・コンテナに伝播されるようにすることができます。

そのためには、RegionControllerインタフェースを実装する新規のクラスを作成します。その後、モデルの準備フェーズの前に実行するカスタム・コードも含めて、次のrefreshRegionメソッドを記述します。

例21-4 regionRefreshメソッド

public boolean refreshRegion(RegionContext regionCtx)
   {
      int refreshFlag = regionCtx.getRefreshFlag();
      if (refreshFlag == RegionBinding.PREPARE_MODEL)
      {
         // Execute some code before
      }
      // Propagate the refresh to the inner binding container
      regionCtx.getRegionBinding().refresh(refreshFlag);
      
      return false;
   }
 
   public boolean validateRegion(RegionContext regionCtx)
   {
      // Propagate the validate to the inner binding container
      regionCtx.getRegionBinding().validate();
      
      return false;
   }

例21-4に示すように、リフレッシュ・フラグの値は次のようになります。

  • RegionBinding.PREPARE_MODEL - ADFライフサイクルprepareModelフェーズ時に発生するイベントに対応

  • RegionBinding.RENDER_MODEL - ADFライフサイクルprepareRenderフェーズ時に発生するイベントに対応