連合ポータル ガイド

リモート ポートレットでのポートレット間の通信

WebLogic Portal は、プロデューサとコンシューマ間のポートレット間通信 (IPC) に対応します。たとえば、プロデューサ アプリケーション内でデプロイされるリモート ポートレットは、コンシューマ内のローカル ポートレットにより開始される最小化イベントを処理できます。この章では、リモート ポートレットを使ったポートレット間通信の使用方法を説明する詳しい例を取り上げます。

この章には次の節があります。

はじめに

WebLogic Portal は WSRP プロトコルに拡張を提供し、リモート ポートレットがライフサイクルの対話段階の間にイベントを開始できるようにします。連合ポートレットに対する WebLogic Portal IPC アーキテクチャの詳細については、「イベントによるポートレット間の通信」を参照してください。

コンシューマおよびプロデューサ アプリケーションでデプロイされるポートレット間の通信は双方向です。ローカル ポートレットにより開始されるイベントは、プロデューサにデプロイされているポートレットで処理でき、その逆も可能です。

この章の例は、連合ポータルでイベント処理を実装する 1 つの方法を示しています。この例では、イベント ハンドラがプロデューサのポートレットに追加されます。コンシューマ上のローカル ポートレットがイベントを開始するとき、プロデューサ上のリモート ポートレットはイベントを受信してそれを処理します (ポートレットに表示されるテキストを変更します)。

WebLogic Portal における IPC の詳細については、『ポートレット開発ガイド』を参照してください。

最小化イベントの開始と処理

この節では、リモート ポートレットでイベント処理を使用する方法を説明する詳しい例を取り上げます。この例では、コンシューマ側のリモート ポートレットが onMinimize イベントを開始します。onMinimize イベントは、ポートレットが最小化されるときに開始されます。イベントがコンシューマ側のローカル ポートレットから開始されるとき、イベントはプロデューサ側で処理されます。onMinimize イベントは WebLogic Portal フレームワークによりサポートされる標準イベントの 1 つです。標準イベントの詳細リストについては、『ポートレット開発ガイド』を参照してください。

この例では、ユーザがコンシューマ側のリモート ポートレットを最小化するとき、プロデューサがイベントを処理し、ポートレット内の一部のテキストを変更します。

この例には次の手順があります。

環境の設定

この節で取り上げている例を試すには、Workshop for WebLogic を実行し、前提条件のタスクを実行して、その例の環境を設定する必要があります。

その例の環境を設定するには、表 7-1 に説明されている前提条件のタスクを実行します。このようなタスクの特定の手順に精通していない場合、WebLogic Portal チュートリアルの「ポータル開発環境の設定」にその詳細が説明されています。

図 7-1 は、前提条件タスクが完了した後のパッケージ エクスプローラを示しています。

プロデューサでのポートレットの作成

このタスクでは、プロデューサ側に 2 つの JSP ファイルと、それぞれのファイルを表示するための JSP ポートレットを作成します。2 つのポートレット間の通信を完了するのに必要な指示を含むバッキング ファイルも作成し、ポートレットの 1 つにイベント ハンドラを追加します。ポートレットを作成して、バッキング ファイルを追加した後で、アプリケーションをブラウザでテストします。

JSP ファイルとポートレットの作成

プロデューサにデプロイされるポートレットが表示する JSP ファイルを作成するには、次の手順に従います。

チェックポイント : この時点で、producerWeb/WebContent フォルダに次のファイルが作成されています。

バッキング ファイルの作成

この例では、プロデューサ内のポートレットに追加されたバッキング ファイルを使用して、コンシューマ側で開始された onMinimize イベントを処理します。

バッキング ファイルを作成するには、次の手順に従います。

ソースは、図 7-6 のようになります。

バッキング ファイルの追加

ここでは、前の節で作成したバッキング ファイルを bPortlet.portlet に追加します。

イベント ハンドラの bPortlet への追加

ここでは、イベント ハンドラを bPortlet.portlet に追加します。ハンドラは別のポートレットにより開始されたイベントをリスンして、そのイベントに対応するアクションを実行するようにコンフィグレーションされます。イベント ハンドラを追加するには、次の手順に従います。

チェックポイント : バッキング ファイルとイベント ハンドラを bPortlet に追加しました。ポートレットが aPortlet により開始された onMinimize イベントを受信するとき、イベント ハンドラはバッキング ファイルで handlePortalEvent() メソッドを起動するようにコンフィグレーションされます。次のタスクで、アプリケーションをテストして、ローカル環境で正しくポートレットが機能していることを確認します。次に、コンシューマ アプリケーションでリモート ポートレットを作成して、連合ポータル環境でポートレット間通信をテストします。

アプリケーションのテスト

次の手順に従って、ipcLocal.portal というプロデューサ アプリケーションでポータルを作成します

まとめ

2 つのローカル ポートレットを含むポータルを作成しました。bPortlet というポートレットをコンフィグレーションして、aPortlet というポートレットから開始された onMinimize イベントに応答しました。onMinimize イベントは、すべての WebLogic Portal ポートレットが開始できる標準イベントです。bPortlet が onMinimize イベントを受信すると、ポートレットにより表示されるテキストを変更するバッキング ファイル メソッドが呼び出されます。

次の手順で、ポートレット間通信を使用する連合ポータルを作成します。

コンシューマ ポートレットの作成

この節では、コンシューマ アプリケーションに JSP ポートレットとリモート ポートレットの 2 つのポートレットを作成します。リモート ポートレットは、プロデューサで作成したポートレットの bPortlet.portlet を使用します。

実習の設定

この実習を続ける前に、次の手順を実行します。

リモート ポートレットの作成

リモート ポートレットを作成するには、次の手順に従います。

まとめ

2 つのコンシューマ ポートレットが完成し、リモート ポートレットとローカル ポートレットのポートレット間の通信を実行するために必要なすべてのコンポーネントを作成したことになります。次の手順では、コンシューマのポートレットをコンシューマのポータルに追加し、1 つのポートレットでイベントを発生させることで、もう 1 つのポートレットで反応を引き起こします。

アプリケーションのテスト

この手順では、コンシューマ アプリケーションをテストして、aPortlet の最小化により bPrime (リモート ポートレット) のコンテンツが変化することを確認します。ポータルを作成し、「コンシューマ ポートレットの作成」で作成した 2 つのポートレットを追加します。アプリケーションを構築し、ブラウザにポータルを表示します。

ポータルの構築

次の手順に従って、ipcConsumer.portal というプロデューサ アプリケーションでポータルを作成します。

ポータルのテスト

ユーザ側から見ると、コンシューマ ポータルは、すべてのポートレットがローカルであるかのように機能します。ユーザは、bPrime が、プロデューサ アプリケーションにホストされているリモート ポートレットであることに気付きません。コンシューマ ポートレットをテストするには、aPortlet を最小化します。リモート ポートレットの bPrime は、それに応じて、表示するテキストを変更します。

リモート ポートレット ファイルの内部

コード リスト 7-3 は、この章で既述のように、リモート ポートレットに対する .portlet ファイルの XML コンテンツからの引用の bPrime.portlet を表示します。要素の dispatchToRemotePortlet が、handleEvent 定義の一部として追加されます。この要素は、コンシューマがこのイベントをプロデューサにディスパッチする必要があることを示します。

<netuix:handleEvent event="onMinimize" eventLabel="handlePortalEvent1"
    fromSelfInstanceOnly="false" onlyIfDisplayed="true"
    sourceDefinitionLabels="aPortlet_1"> <netuix:dispatchToRemotePortlet/>
</netuix:handleEvent>
...

カスタム イベントによるデータ転送

カスタム イベントは、コンシューマ アプリケーションでデプロイされるポートレットと、リモート プロデューサ アプリケーション内のポートレット間でデータを転送するための推奨されている方法です。この節では、カスタム イベントを使用して、コンシューマからプロデューサへデータを転送するのに利用可能な技術について概説します。

図 7-24 は、この節で説明されている例のコンフィグレーションを示しています。

プロデューサ側のイベントの検索

この節では、プロデューサ側のポートレットが、ペイロードを含むカスタム イベントを処理するようにコンフィグレーションする方法を説明します。この場合、ポートレットは、コード リスト 7-4 に示されるクラスに関連する Java ポートレットです。

import java.io.IOException;
import javax.portlet.PortletException;
import javax.portlet.GenericPortlet;
import javax.portlet.RenderResponse;
import javax.portlet.RenderRequest;
import javax.portlet.ActionResponse;
import javax.portlet.ActionRequest;
import com.bea.netuix.events.Event;
import com.bea.netuix.events.CustomEvent;

public class JavaPortlet extends GenericPortlet {

     public void getMessage(ActionRequest request, ActionResponse response, 
                             Event event) { 
           CustomEvent customEvent = (CustomEvent) event; 
           String message = (String) customEvent.getPayload(); 
           response.setRenderParameter("message0", message);
     }

     public void doView(RenderRequest request, RenderResponse response)
           throws PortletException, IOException {

           String message = request.getParameter("message0");
           if (message == null) message = "";
           response.setContentType("text/html");
           response.getWriter().write("<p><b>Message From Consumer: </b>" + 
            message + "</p>");

     }
}

getMessage() メソッドはカスタム イベント オブジェクトを取得します。このオブジェクトには、コンシューマからプロデューサへ送信されるペイロードが含まれています。次の手順で、カスタム イベントをリスンし、このイベントが受信されるときに getMessage() メソッドを呼び出すイベント ハンドラを作成します。この場合、カスタム イベントがカスタム アプリケーションにデプロイされるポートレットにより開始されます。

プロデューサ ポートレットにイベント ハンドラをコンフィグレーションするには、次の手順に従います。

Java ポートレットは messageCustomEvent というカスタム イベントを処理するようにコンフィグレーションされています。このイベントを受信すると、ハンドラは JavaPortlet クラスで getMessage() メソッドを呼び出します。このイベント ハンドラは、プロデューサ上のこのポートレットと、リモート コンシューマ上のポートレットなどのその他のポートレットとの、ポートレット間通信のメカニズムを提供します。

コンシューマでのイベントの開始

コンシューマ ポートレットは、カスタム イベントを開始し、次にプロデューサで処理されるようにコンフィグレーションできます。コード リスト 7-5 は、コンシューマ側のローカル ポートレットで、カスタム イベントを開始し、ぺイロードをイベントに追加するために使用できるコードを示しています。

       PortletBackingContext context =
       PortletBackingContext.getPortletBackingContext(getRequest());        
         context.fireCustomEvent("messageCustomEvent", form.getMessage());   
       return new Forward("success");

fireCustomEvent() メソッドの詳細については、「Javadoc」を参照してください。ポートレット開発とイベント処理の詳細については、『ポートレット開発ガイド』を参照してください。