カテゴリー: Java

JSR 286 Portlet Specification 2.0 (PLT.9.4 – PLT.10.4.3)

続き・・・

PLT.9.4 Custom Window States

カスタムウィンドウ状態の例は以下のようにdescription、window-stateになった。

<portlet-app>
...
<custom-window-state>
<description>Occupies 50% of the portal page</description>
<window-state>half_page</window-state>
</custom-window-state>
...
</portlet-app>

PLT.9.5 Defining Window State Support

ポータルは事前定義のNORMAL, MAXIMIZED, MINIMIZED をサポートする。宣言されていないカスタムウィンドウ状態は呼び出さない。配備記述子では以下のように定義される。

<supports>
<mime-type>text/html</mime-type>
<portlet-mode>edit</portlet-mode>
<portlet-mode>help</portlet-mode>
<window-state>half-page</window-state>
...
</supports>
<supports>
<mime-type>text/vnd.wap.wml</mime-type>
<portlet-mode>help</portlet-mode>
...
</supports>

以上の例では、HTMLについては、事前定義のウィンドウ状態に加えて、HALF-PAGEウィンドウ状態をサポートすることになる。WMLは、事前定義のウィンドウ状態のみのサポートになる。

ポータルがサポートしていないウィンドウ状態については、無視か、マッピングしない。

PLT.10 Portlet Context

PortletContextはポートレットの実行でのポートレットアプリケーションのポートレットの表示を定義している。PortletContextを利用すると、ログ、リソースや実行時のオプションにアクセスできたり、他のポートレットやサーブレットでアクセスできる属性を入れることができる。実行時のオプションというのが新しい点だろうか。

PLT.10.4 Portlet Container Runtime Options

ポートレットは、ポートレットアプリケーションレベルまたはポートレットレベルで追加の実行時オプションを定義できる。ポートレットアプリケーションレベルのオプションはすべてのポートレットに適用され、ポートレットレベルのオプションは固有のポートレットに適用され、ポートレットアプリケーションレベルのオプションを上書きする。

実行しているポートレットのPortletContextのgetContainerRuntimeOptionsメソッドを通して、コンテナ実行時オプションを取得する。このメソッドは、Mapを返してくる。portlet.xmlに設定されていなければ、空のMapになる。

PLT.10.4.1 Runtime Option javax.portlet.escapeXml

1.0のときは、URLのXMLエスケープについては、定義されていなかった。なので、XMLエスケープされているURLを想定しなくてもよかった。2.0では、それらを動かすには、javax.portlet.escapeXml実行時オプションが必要。定義は以下のような感じ。

<portlet>
…
<container-runtime-option>
　<name>javax.portlet.escapeXml</name>
　　<value>false</value>
</container-runtime-option>
</portlet>

PLT.10.4.2 Runtime Option javax.portlet.renderHeaders

renderフェーズでヘッダーを書く必要があるポートレットは、この実行時オプションを利用する。デフォルトは、false。詳細はPLT11.1.1.3.3。例、

<portlet>
…
<container-runtime-option>
<name>javax.portlet.renderHeaders</name>
<value>true</value>
</container-runtime-option>
</portlet>

PLT.10.4.3 Runtime Option javax.portlet.includedPortletSessionScope

JSP内のセッション変数はアプリケーションスコープのポートレットセッションにマップされるけど、それが調整可能になるみたい。そのためにこの実行時オプションを利用する。

<portlet>
…
<container-runtime-option>
<name>javax.portlet.includedJSPPortletSessionScope</name>
<value>PORTLET_SCOPE</value>
</container-runtime-option>
</portlet>

ポートレット開発者は、すべてのポートレットコンテナが以上の機能を提供できるというわけではないことに注意されたし。これに依存すると、実行時にポートレットコンテナで制限となるかも。

今日はここまで・・・

JSR 286 Portlet Specification 2.0 (PLT.7.1.1.1 – PLT.8.7)

つづき・・・

PLT.7.1.1.1 URL Properties

URLにベンダ固有の情報を設定するために、ポートレットで利用可能なプロパティがある。BaseURLのsetPropertyとaddPropertyでそれが可能で、setProperty で名前と値を渡して設定して、再度、setPropertyをすれば、上書きされる。addPropertyはあたえられた名前に値を追加する。

PLT.8.4 Custom Portlet Modes

ちょっとここは変更が入っている。ポートレットがポータルが管理していないモードを追加してよいとある。ポータルによって管理されないモードは、portal-maangedタグをfalseとして宣言するそうな。

ポートレットは、カスタムポートレットモードを利用するポートレット配備記述子にcustom-portlet-mode要素で定義する。配備時に、ポータルで管理されているモードは、ポータルに実装されるモードにマップされる。一方、ポータルに管理されないモードを藻津ポートレットは、カスタムポートレットモードセクションのdecoration-name要素のテキストとして提供される。このテキストは、リソースバンドルで翻訳可で、リソースバンドルがなければ、decoration-nameタグで提供された名前をそのままモード名として利用することになる。まぁ、別にそこまでしなくてもサポートしないモードとして、放置でもいいみたい。

以下が例。

<portlet-app>
...
<custom-portlet-mode>
<description>Creates content for Cut and Paste</description>
<portlet-mode>clipboard</portlet-mode>
<portal-managed>false</portal-managed>
<decoration-idname>ClipboardMode</decorationidname>
</custom-portlet-mode>
<custom-portlet-mode>
<description>Provides administration functions</description>
<portlet-mode>configadmin</portlet-mode>
<portal-managed>true</portal-managed>
</custom-portlet-mode>
...
</portlet-app>

というわけで、decoration-nameとportal-managedが新登場。

PLT.8.5 GenericPortlet Render Handling

renderメソッドもアノテーションがサポートされている。@RenderMode(name=<portlet mode name>)という感じ。メソッドは、

void <methodname> (RenderRequest, RenderResponse) throws
PortletException, java.io.IOException;

という感じ。GenericPortletで特にマッチするのがなければ、doView, doEdit, doHelpが呼ばれる。

PLT.8.7 Setting next possible Portlet Modes

どうやら、表示する際に、その表示したときの状態に対して、選択できるポートレットモードを指定できるらしい。指定しなければ、従来通り、ポートレット配備記述子に書いたものが全部表示される。javax.portlet.renderHeaders(これはいまいち謎？)を指定できるか、GenericPortletのgetNextPossiblePortletModesを上書きしても良いし、setNextPossiblePortletModesでRENDER_HEADERS内にセットも可能らしい(PLT.11.1.1.3.3を見るべし)

とりあえず、ここまで・・・。