JSP用Liferayポートレットオブジェクト
JSPの中に <liferay-portlet:defineObjects> というタグがあることにお気づきでしょうか？ theme:defineObjectsタグと同様に、このタグをJSPに含めると、いくつかの変数にアクセスできるようになり、この場合、ポートレットに関する有用な情報を返すことができます。 なお、JSR-286仕様では、ポートレットのライフサイクルとして、processAction、processEvent、render、serveResourceの4つのメソッドを定義しています。 <portlet:defineObjects/> タグで定義される変数のいくつかは、ポートレットのライフサイクルの適切なフェーズにJSPが含まれていた場合にのみ、JSPから利用可能になります。 これらのオブジェクトは、以下の表で説明されています。
| オブジェクト | Description |
|---|---|
ActionRequest actionRequest |
アクションを処理するためにポートレットに送信されたリクエストを表します。 actionRequestは、JSPがアクション処理フェーズに含まれていた場合のみJSPで利用可能です。 |
ActionResponse actionResponse |
アクションリクエストに対するポートレットの応答を表します。 actionResponseは、JSPがアクション処理フェーズに含まれていた場合のみJSPで利用可能です。 |
EventRequest eventRequest |
イベントを処理するためにポートレットに送信されるリクエストを表します。 eventRequestは、JSPがイベント処理フェーズに含まれていた場合のみJSPで利用可能です。 |
EventResponse eventResponse |
イベントリクエストに対するポートレットの応答を表します。 eventResponseは、JSPがイベント処理フェーズに含まれていた場合のみJSPで利用可能です。 |
HeaderRequest headerRequest |
ポートレットのHTMLヘッダまたはHEADセクションを処理するためにポートレットに送信されるリクエストを表します。 headerRequestは、JSPがヘッダー処理フェーズに含まれていた場合のみJSPで利用可能です。 |
HeaderResponse headerResponse |
ヘッダーリクエストに対するポートレットの応答を表します。 headerResponseは、JSPがヘッダー処理フェーズに含まれていた場合のみJSPで利用可能です。 |
LiferayPortletRequest liferayPortletRequest |
HttpServletRequest、Portlet、およびポートレット名とライフサイクル値へのアクセスを提供します。 liferayPortletRequestは、すべてのポートレットフェーズで利用可能です。 |
LiferayPortletResponse liferayPortletResponse |
ポータルに返されるプロパティを含み、プロパティを追加または変更する手段を提供します。 liferayPortletResponseは、すべてのポートレットフェーズで利用可能です。 |
RenderRequest renderRequest |
ポートレットを描画するために、ポートレットに送信されたリクエストを表します。 renderRequestは、JSPがレンダーリクエストフェーズで含まれていた場合のみJSPで利用可能です。 |
RenderResponse renderResponse |
ポートレットがポータルに応答を送信する際に補助するオブジェクトを表します。 renderResponseは、JSPがレンダーリクエストフェーズで含まれていた場合のみJSPで利用可能です。 |
ResourceRequest resourceRequest |
リソースを描画するためにポートレットに送信されたリクエストを表します。 resourceRequestは、JSPがリソース提供フェーズで含まれていた場合のみJSPで利用可能です。 |
ResourceResponse resourceResponse |
ポートレットがリソースを描画する際に補助するオブジェクトを表します。 resourceResponseは、JSPがリソース提供フェーズに含まれていた場合のみJSPで利用可能です。 |
PortletConfig portletConfig |
ポートレットの名前、初期化パラメータ、リソースバンドル、アプリケーションコンテキストを含むポートレットの設定を表します。 portletConfigは、それが含まれるリクエスト処理フェーズにかかわらず、常にポートレットJSPで利用可能です。 |
PortletPreferences portletPreferences |
ポートレットの設定へのアクセスを提供します。 portletPreferencesは、それが含まれるリクエスト処理フェーズにかかわらず、常にポートレットJSPで利用可能です。 |
Map<String, String[]> portletPreferencesValues |
portletPreferences.getMap()呼び出しと同等のマップを提供するか、ポートレットのルック&フィールが存在しない場合は空のマップを提供します。 |
PortletSession portletSession |
複数のリクエストにまたがってユーザーを識別する方法と、ユーザーに関する一時的な情報を保存する方法を提供します。 portletSessionは、各ユーザークライアントに対して作成されます。 portletSessionは、それが含まれるリクエスト処理フェーズにかかわらず、常にポートレットJSPで利用可能です。 portletSessionは、セッションが存在しない場合はnullです。 |
Map<String, Object> portletSessionScope |
PortletSession.getAtrributeMap()呼び出しと同等のマップ、またはセッション属性が存在しない場合は、空のマップを提供します。 |
詳しくは、 Portlet 3.0 API Javadoc をご覧ください。