ポートレット開発ガイド

ポートレットの開発について

この章では、WebLogic Portal を使用したポートレットの開発を始める際に役立つ、概念および参照情報について説明します。ポートレット設計に関連するコンポーネントの詳細については、『ポータル開発ガイド』を参照してください。各種ポートレットの作成手順については、「ポートレットの構築」を参照してください。

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

ポートレットのコンポーネント

ポートレットは、アプリケーション、情報、およびビジネス プロセスを表示する、Web ブラウザ内のモジュラー ペインです。ポートレットには、静的 HTML コンテンツ、Java コントロール、複雑な Web サービス、プロセスの多いアプリケーションなどの情報を格納することができます。ポータル アプリケーション内では、ポートレットは拡張子 .portlet の XML ファイルとして表示されます。Workshop for WebLogic でポートレットを構築する場合、XML 要素と属性が自動的に構築されます。

図 4-1 は、.portlet ファイルに含まれる、ポートレットを構成するコンポーネントを示しています。灰色の文字のオブジェクトについては、『ポータル開発ガイド』で詳しく説明しています。

この節では、次のトピックについて説明します。

ポートレット プロパティ

ポートレットのプロパティは、ポートレットをユニークに識別し、ポートレットの特性を定義する名前付きのポートレットの属性です。タイトル、定義ラベル、コンテンツ URI などのプロパティは必須です。スクロール、プレゼンテーション プロパティ、事前処理 (認可のためなど)、マルチスレッド表示など、特定の機能を有効にするための任意のプロパティも数多く存在します。ポートレットに使用するプロパティは、そのポートレットの使い方に応じて異なります。

ポートレット プロパティの詳細および設定方法については、「ポートレット プロパティ」を参照してください。

ポートレットのタイトル バー、モード、および状態

ポートレットの作成時に、タイトル バーの有無を選択できます。また、WebLogic Portal で作成したすべてのポートレットは、モードおよび状態をサポートします。モードはポートレットのコンテンツに影響します。編集、ヘルプ、フロート、およびカスタム モードを利用できます。状態は、ポートレットの表示に影響します。最小化、最大化、通常、フロート、および削除状態を利用できます。

ポートレットでモードおよび状態を設定するには、ポートレットのタイトル バーを有効にする必要があります。

特定の状況において、ポートレットのモードおよび状態の設定が、ポートレット間通信など他のポートレット機能の設定に影響する場合があります。たとえば、ポートレットをリスンするイベント ハンドラを設定する場合、リスン先のポートレットのウィンドウが最小化されておらず、ビュー モードになっている場合のみ、イベント ハンドラを実行できます。

ポートレットのモードおよび状態の設定手順については、「ポートレットの外観と機能」を参照してください。

ポートレット プリファレンス

ポートレットは、特定のポータルで再利用できる個々のアプリケーションです。作成したポートレットは、複数回インスタンス化できます。

ポートレットのインスタンスを複数作成できるほか、ポートレットのプリファレンスを指定できます。プリファレンスを使用すると、同一のコードおよびユーザ インタフェースを使用しつつ、各ポートレット インスタンスの動作を変更できます。ポートレット プリファレンスは、アプリケーション データをポートレットと関連付ける中心的な手段を提供します。この機能は、使用方法に基づいてポートレットをパーソナライズする際に重要となります。

可能な限りポートレットを再利用できるようにポートレットの実装を計画します。再利用の計画により、一意のプリファレンスを設定して汎用的なポートレットを区別できるため、開発およびテスト作業を簡略化できます。

ポートレット プリファレンスの設定手順については、「ポートレット プリファレンス」を参照してください。

ポートレットを作成するためのリソース

ポートレット ウィザードにより、ポートレットを簡単に作成することができますが、ポートレット作成の中心的な手段としては不十分な場合があります。既存のポートレットの複製、または既存の JSP や Struts モジュールに基づいたポートレットの生成など、さまざまな方法を使用してポートレットを作成できます。以下を含む多くのリソースにより、ポートレットの「材料」が提供されます。

既存リソースを使用してポートレットを構築する手順については、「ポートレットの構築」を参照してください。

ポートレットの表示

ポートレットの表示は、以下の 2 つのプロセスから構成されます。

一般的な表示に関するトピックについては、『ポータル開発ガイド』を参照してください。この節では、以下のポートレット固有の表示トピックについて説明します。

表示および事前表示フォーク

デフォルトでは、ページ上の各ポートレットの事前表示および表示は順番に行われます。すべてのポートレットの処理が終わるまで、ポータル ページは表示されません。このため、Web ページの表示が大幅に遅れ、Web サイトで障害が発生しているとユーザに受け取られる可能性があります。このような状況を防ぐため、マルチスレッド フォーク処理を使用して、事前表示および表示タスクを並行して行うようポートレットを設定できます。

表示段階でのポートレットのフォークは、すべてのポートレット タイプでサポートされます。事前表示フォークは、以下のポートレット タイプでサポートされます。

フォークされたポートレットの実装手順については、「ポートレットの並列表示」を参照してください。

ポートレット コンテンツの非同期表示

ポートレットの非同期表示によって、周りのポータル ページから独立してポートレットのコンテンツを表示できます。ポートレットの非同期表示を使用すると、ポートレットは 2 つの段階で表示されます。まず、通常のポータル ページ リクエスト処理が行われ、この処理中にタイトル バーなどコンテンツ以外の領域が表示されます。さらに、次のリクエストでポートレットのコンテンツが表示されます。

コンテンツの非同期表示の実装手順については、「ポートレット コンテンツの非同期表示」を参照してください。

ポップアップとしてのポートレット (デタッチされたポートレット)

WebLogic Portal は、デタッチされたポートレットの使用をサポートします。デタッチされたポートレットは、ポップアップ形式の動作を提供します。GroupSpace Message Center および Administration Console ウィザードで、WebLogic Portal におけるデタッチされたポートレットの使用例を確認できます。

デタッチされたポートレットの使用手順については、「デタッチされたポートレット」を参照してください。

ポートレットでの JSP タグおよびコントロール

WebLogic Portal には、JSP 内で使用できる JSP タグが用意されています。ポートレットは、コンテンツ ノードとして JSP を使用できます。これにより、再利用、パーソナライゼーション、およびその他のプログラム機能を実現できます。Workshop for WebLogic で JSP デザイン パレット ビューを使用すると、使用可能な JSP タグを表示して、それらを JSP のソース ビューにドラッグしたり、プロパティ ビューを使用してコードの要素を編集したりできます。

ポータルの開発時に利用可能な JSP タグを表示するには、[ウィンドウ｜ビューの表示｜JSP デザイン パレット] を選択します。

また、WebLogic Portal には、ビルド済みモジュールをポータルに簡単に追加できるようにするためのカスタム Java コントロールがあります。カスタム Java コントロールは、イベント管理、訪問者ツール、コミュニティ管理などに使用されます。たとえば、ほとんどのユーザ管理機能は、ページ フローの User Manager コントロールを使用して簡単に公開できます。

WebLogic Portal の JSP タグに関連付けられたクラスについては、「Javadoc」を参照してください。

ポートレット内でのコントロールの使用の詳細については、「ポートレットでの JSP タグおよびコントロール」を参照してください。

バッキング ファイル

コントロールのライフサイクル内のポートレットの動作を制御する最も一般的な方法は、ポートレット バッキング ファイルを使用することです。ポートレット バッキング ファイルは、init() および preRender() など、ポータルのコントロール ライフサイクル段階に関連するメソッドを格納できる Java クラスです。ポートレット コントロール自体を抽象化したポートレットのバッキング コンテキストを使用して、ポートレットの特性をクエリして変更できます。たとえば、init() ライフサイクル メソッドでは、要求パラメータが評価され、そのパラメータの値に応じて、ポートレットのバッキング コンテキストを使用してポートレットを表示するか非表示にするかを指定できます。

バッキング ファイルは、Workshop for WebLogic を使用するか、または .portlet ファイルにコードを直接入力することによって、ポータルに追加できます。

バッキング ファイルの実装の詳細については、「バッキング ファイル」を参照してください。