41 非同期バックエンドでのアクティブ・データ・サービスの使用方法
この章の内容は次のとおりです。
アクティブ・データ・サービスについて
特定のADF Facesコンポーネントを構成すると、アクティブ・データ・サービス(ADS)からのデータを整理して、リアルタイムのデータ更新を実行できます。
Fusionテクノロジ・スタックには、アクティブ・データ・サービス(ADS)が含まれ、これはサーバー側のプッシュ・フレームワークで、これによりADF Facesコンポーネントのリアルタイムのデータ更新を提供できます。ADF Facesコンポーネントをデータ・ソースにバインドすると、ADSでは、ブラウザ・クライアントに明示的な更新リクエストを要求することなく、ブラウザ・クライアントにデータ更新をプッシュします。たとえば、ADFデータ・コントロールの属性にバインドされた表があり、その属性値はサーバー上で定期的に変化するため、表には更新された値が表示されるようにします。ユーザーはJava Beanを作成してActiveModel
インタフェースを実装し、それをイベント・リスナーとして登録すると、コンポーネントにバックエンドからのデータ・イベントを通知できます。そのコンポーネントは図41-1に示されるように、新しい値が強調表示された変更済データを再レンダリングします。
図41-1 更新されたデータを強調表示で示す表
![この図は周囲のテキストで説明しています この図は周囲のテキストで説明しています](img/ads_table.png)
アクティブ・データ・サービスのユースケースおよび例
ADF FacesコンポーネントにバインドされているADFデータ・コントロールに関連付けられたビジネス・ロジックの結果として、バックエンドで変化するデータをレンダリングするには、自動部分ページ・レンダリング(PPR)のかわりにADSを使用します。自動PPRでは(通常、ユーザーが)サーバーに要求を送信する必要がありますが、ADSは、変更されたデータがサーバーに到着したときに、このデータをデータ・ストアからプッシュできるようにします。また、PPRとは対照的に、ADSにより、コンポーネントはコンポーネント全体ではなく、変更されたデータのみをレンダリングできるようになります。したがって、アプリケーションが、定期的に変化するデータに対応する必要がある場合にはADSが理想的です。
この機能を使用するには、ADSを使用するようにアプリケーションを構成する必要があります。アプリケーション・サービスがADSをサポートしていない場合は、サービスのプロキシを作成して、データがソースで更新されたときに、コンポーネントがこのデータを表示できるようにする必要もあります。
どのADF FacesページでもADSを使用できます。ただし、アクティブ・データを処理するように構成できるのは、次のADF FacesコンポーネントおよびADFデータ視覚化(DVT)コンポーネントのみです。
-
activeImage
-
activeOutputText
-
chart
(すべてのタイプ) -
gauge
(すべてのタイプ) -
pivotTable
-
tree
-
treeTable
-
geoMap
(mapPointTheme
のみ) -
sunburst
-
treemap
DVTコンポーネントに対するADSサポートの詳細は、「アクティブ・データ・サポート」を参照してください。
また、コレクションベースのコンポーネント(table
、tree
、pivotTable
など)は、outputText
コンポーネントまたはsparkChart
がアクティブ・データを表示するように構成されている場合にのみADSをサポートします。その他のコンポーネントは、コレクションベース・コンポーネントの内部でサポートされません。
アクティブ・データ・サービス・フレームワークの詳細と構成に関する重要な情報は、Oracle Application Development FrameworkによるFusion Webアプリケーションの開発で、アクティブ・データ・サービスの使用を参照してください。
アクティブ・データ・サービスを使用するためのプロセスの概要
ADFアプリケーションでのアクティブ・データ・サービス(ADS)は、アプリケーション・レベルと、アクティブ・データの整理に使用するADF Facesコンポーネントのレベルで構成されます。
ADSを使用するために、必要に応じてアプリケーションを構成して、データ転送の方法やその他のパフォーマンス・オプションを決定することができます。
始める前に:
次のタスクを実行します。
-
データ・ソースから非同期的にアクティブ・データ・イベントを起動するロジックを実装します。たとえば、このロジックとしては、データベースを更新するビジネス・プロセス、またはJMSから通知を受けるJMSクライアントなどが考えられます。
-
アクティブ・データ・フレームワークは、ユーザー・プロファイルやセキュリティなどADF実行時コンテキストを必要とする複雑なビジネス・ロジックや変換をサポートしません。たとえば、このフレームワークはADFコンテキストのロケール依存値を変換し、ロケール固有の値を返すことはできません。そのかわりに、ユーザーは、データ変更イベントを公開する前に、データ・ソースにこれを処理させる必要があります。
-
ユーザーがADF Facesページをアプリケーション用に構成されたADSで実行できるようになるには、その前にWebブラウザのポップアップ・ブロッカを無効にする必要があります。ポップアップ・ブロッカが有効になっているWebブラウザでは、アクティブ・データはサポートされません。
アクティブ・データ・サービスを使用する手順:
マネージドBeanでのActiveModelインタフェースの実装
ADFアプリケーションのビュー・レイヤーでADF Facesコンポーネントへのデータを整理する場合は、ActiveModel
インタフェースを実装するバッキングBeanを作成し、それをバックエンドからのアクティブ・データ・イベントのリスナーとして登録します。
プロパティとしてアクティブ・モデル実装を含むバッキングBeanを作成します。このクラスでは、JSFモデルをラップするのにADSデコレータ・クラスを使用します。このクラスでは、データをADSフレームワークにプッシュするバックエンドからのコールバックも実装されます。
次のADSデコレータ・クラスのいずれかをサブクラスとして持つJavaクラスを作成する必要があります。
-
ActiveCollectionModelDecorator
class -
ActiveGeoMapDataModelDecorator
class
これらのクラスは、アクティブ・データ機能をActiveDataModel
のデフォルト実装に委譲するラッパー・クラスです。ActiveDataModel
クラスは、データ変更イベントをリッスンし、イベント・マネージャと対話します。
特に、ActiveModel
インタフェースを実装するときには、次のことを完了します。
-
JSFモデル・インタフェースをラップします。たとえば、
ActiveCollectionModelDecorator
クラスはCollectionModel
クラスをラップします。 -
データ・ソースから、データ変更イベントに基づいてアクティブ・データ・イベントを生成します。
ActiveModel
インタフェースを実装するには、データの送信先で、それ自体がアクティブ・データ・ソースのリスナーとして登録されるモデルを取得するJavaクラスに、メソッドを実装する必要があります(次の例を参照)。
クラスをマネージドBeanとしてfaces-config.xml
ファイルに登録します。次の例では、StockManager
Beanの登録を示しています。マネージドBeanを定義することにより、ADF Facesコンポーネントの値プロパティの式でそのマネージドBeanを指定できます。
... <managed-bean> <managed-bean-name>stockManager</managed-bean-name> <managed-bean-class> oracle.afdemo.view.feature.rich.StockManager </managed-bean-class> <managed-bean-scope>session</managed-bean-scope> </managed-bean>
読取り一貫性の維持に関する必知事項
読取り一貫性とは、ADFアプリケーションがアクティブなデータをプッシュするタイミングが、ADF Facesコンポーネントによるデータのリフレッシュより後に、かつアクティブなデータ・イベントがWebブラウザに届くより前になるよう保証する機能です。
アクティブ・データを使用するということは、コンポーネントに2つのデータ・ソース(アクティブ・データ・フィードと標準データ・フェッチ)があることを意味します。このため、アプリケーションでは読取り一貫性が確保されるようにする必要があります。
たとえば、ページには表が1つ含まれ、この表ではアクティブ・データが有効化されているとします。この表は、データを更新するための配信メソッドとして、標準の表データ・フェッチとアクティブ・データ・プッシュの2種類を持っています。ここで、バック・エンド・データがfoo
からbar
に変更され、さらにfred
に変更されたとしましょう。変更のたびに、アクティブ・データ・イベントが起動されます。これらのイベントがブラウザに到着する前に表をリフレッシュした場合、表にはfred
と表示されます。これは、標準のデータ・フェッチでは、必ず最新のデータが取得されるからです。しかし、アクティブ・データ・イベントに長い時間がかかることもあるため、場合によっては、リフレッシュの後で、このデータ変更イベントの結果、foo
がブラウザに到着し、表が更新されて、しばらくの間、fred
のかわりにfoo
と表示されます。したがって、読取り一貫性を維持する方法を実装する必要があります。
読取り一貫性を実現するために、ActiveDataModel
は、効果的にデータにタイムスタンプを押す変更カウントの概念を採用しています。データ・フェッチとアクティブ・データ・プッシュのどちらも、このchangeCount
オブジェクトを単調にカウントを増やすことで維持する必要があるため、返されたデータのchangeCount
が現在のカウントより低い場合は、アクティブ・イベントにより廃棄される可能性があります。ActiveDataModel
クラスの実装を使用して、読取り一貫性を維持する方法の詳細は、「アクティブ・データ・サービスへのイベント渡し」を参照してください。
ADSページからのナビゲーションに関する必知事項
アクティブ・データをADF FacesコンポーネントにプッシュするようにADFアプリケーションを構成する場合は、ユーザーがアクション取消しのオプションを使用できるように、ADSを終了するナビゲーション・イベントを処理する必要があります。
ユーザーが表示中のADS有効ページを表示するブラウザを閉じようとすると、ADSはブラウザのネイティブのwindow.unload
イベントで停止します。ユーザーがページに戻れるようにするアプリケーションの場合、ユーザーがアクションを取り消すことができるように、アプリケーションで確認プロンプトを表示する必要があります。この場合、アプリケーションはブラウザのネイティブのwindow.onbeforeunload
リスナーではなく、ADFクライアント・リスナーbeforeunload
を使用する必要があります。
ADF beforeunload
イベントを処理できるクライアント・リスナーの例は、「ADFクライアント・リスナーをJSFページからの移動の制御に使用する方法」を参照してください。
アクティブ・データ・サービスへのイベント渡し
アクティブ・データをADF FacesコンポーネントにプッシュするようにADFアプリケーションを構成する場合は、BaseActiveDataModel
クラスを拡張し、マネージドBeanによって作成されるアクティブ・データ・イベントをADSフレームワークに渡すクラスを作成します。
マネージドBeanで作成されたイベントを渡すために、BaseActiveDataModel
クラスを拡張するクラスを作成する必要があります。ActiveDataModel
クラスは、データ変更イベントをリッスンし、イベント・マネージャと対話します。具体的には、実装するメソッドで次のことを行います。
-
必要に応じて、アクティブ・データおよび
ActiveDataModel
オブジェクトを開始および停止し、データ・ソースに対するリスナーの登録および登録取消しを行います。 -
イベント・マネージャからリスナーを管理し、アクティブ・データ・イベントをイベント・マネージャにプッシュします。
次の例に、オブジェクトをfireActiveDataUpdate()
メソッドに入れることで、モデルのnotifyDataChange()
メソッドでEvent
オブジェクトをADSフレームワークに渡す方法を示します。
import java.util.Collection; import java.util.concurrent.atomic.AtomicInteger; import oracle.adf.view.rich.activedata.BaseActiveDataModel; import oracle.adf.view.rich.event.ActiveDataUpdateEvent; public class ActiveStockModel extends BaseActiveDataModel { // -------------- API from BaseActiveDataModel ---------- @Override protected void startActiveData(Collection<Object> rowKeys, int startChangeCount) { /* We don't do anything here as there is no need for it in this example. * You could use a listenerCount to see if the maximum allowed listerners * are already attached. You could register listeners here. */ } @Override protected void stopActiveData(Collection<Object> rowKeys) { // same as above... no need to disconnect here } @Override public int getCurrentChangeCount() { return changeCounter.get(); } // -------------- Custom API ----------- /** * Increment the change counter. */ public void prepareDataChange() { changeCounter.incrementAndGet(); } /** * Deliver an ActiveDataUpdateEvent object to the ADS framework. * * @param event the ActiveDataUpdateEvent object */ public void notifyDataChange(ActiveDataUpdateEvent event) { // Delegate to internal fireActiveDataUpdate() method. fireActiveDataUpdate(event); } // properties private final AtomicInteger changeCounter = new AtomicInteger(); }
データ更新イベント・リスナーの登録
アクティブ・データをADF FacesコンポーネントにプッシュするようにADFアプリケーションを構成する場合は、faces-config.xml
ファイルを使用して、バックエンドでのデータ変更に対するデータ変更リスナーを登録します。
バックエンドからのデータ変更イベントに対するデータ変更リスナーを登録する必要があります。次の例では、リスナーBeanStockBackEndSystem
がfaces-config.xml
ファイルに登録されます。この例では、リスナーをバックエンドに挿入するために式言語が使用されています。
... <managed-bean> <managed-bean-name>backend</managed-bean-name> <managed-bean-class> oracle.afdemo.backend.StockBackEndSystem </managed-bean-class> <managed-bean-scope>session</managed-bean-scope> <managed-property> <property-name>listener</property-name> <value>#{stockManager}</value> </managed-property> </managed-bean>
アクティブ・データを表示するためのADFコンポーネントの構成
アクティブ・データをADF FacesコンポーネントにプッシュするようにADFアプリケーションを構成する場合は、プッシュされたデータの表示に使用するADF Facesコンポーネントを実装するマネージドBeanを指定する式を追加します。
コレクションベースのデータを表示するADFコンポーネントは、ADSと提携するように構成することができます。ビュー・レイヤーでは余分なセットアップは必要ありません。リスナーを登録すると、ADSを使用してデータをビュー・レイヤーに流すことができます。たとえば、JSPXページでtable
コンポーネントを使用して、リスナーを登録しているバックエンド・ソースからの在庫の更新を表示するとします。
次の例に、プッシュされたデータを受信するためにtable
コンポーネントのvalue
属性で使用される式言語を示します。
... <f:view> <af:document id="d1"> <af:form id="f1"> <af:panelStretchLayout topHeight="50px" id="psl1"> <f:facet name="top"> <af:outputText value="Oracle ADF Faces goes Push!" id="ot1"/> </f:facet> <f:facet name="center"> <!-- id="af_twocol_left_full_header_splitandstretched" --> <af:decorativeBox theme="dark" id="db2"> <f:facet name="center"> <af:panelSplitter orientation="horizontal" splitterPosition="100" id="ps1"> <f:facet name="first"> <af:outputText value="Some content here." id="menu"/> </f:facet> <f:facet name="second"> <af:decorativeBox theme="medium" id="db1"> <f:facet name="center"> <af:table value="#{stockManager}" var="row" rowBandingInterval="0" id="table1" emptyText="No data..."> <af:column sortable="false" headerText="Name" id="column1"> <af:outputText value="#{row.name}" id="outputText1"/> </af:column> <af:column sortable="false" headerText="Value...." id="column2"> <af:outputText value="#{row.value}" id="outputText2" /> </af:column> </af:table> </f:facet> </af:decorativeBox> </f:facet> </af:panelSplitter> </f:facet> </af:decorativeBox> </f:facet> </af:panelStretchLayout> </af:form> </af:document> </f:view>