JSR 168 ポートレットを構成するには、ポートレット・デプロイメント記述子エディターを開き、「ポートレット」リスト・ボックスからポートレットを選択し、次の値を指定します。
表 1. ポートレット・クラスプロパティー名 |
説明 |
ポートレット・クラス |
「ポートレット」リスト・ボックスで選択されているポートレットの正規名。
「ブラウズ」ボタンを選択して「ポートレットの選択」ダイアログを開き、
デプロイメント記述子の新規マッピングを作成します。<portlet-class> ノードで使用されます。 |
表 2. デプロイメント記述子値のローカリゼーションプロパティー名 |
説明 |
言語 |
「表示名」および「説明」をローカライズするために xml:lang 属性で使用されるロケール情報。xml:lang 属性の
デフォルト値は、英語 (en) です。
<portlet> の <display-name> および <description> の xml:lang 属性で使用されます。 |
表示名 |
ポートレットを識別するために使用される管理名。GUI ツールのみで表示されます。<portlet> の <display-name> で使用されます。 |
説明 |
ポートレットに関する説明テキスト。このテキストはエンド・ユーザーには表示されません。<portlet> の <description> で使用されます。 |
表 3. 言語固有のポートレット情報プロパティー名 |
説明 |
リソース・バンドル |
タイトルやキーワードのような言語固有のポートレット情報を指定するため、リソース・バンドルが使用されます。リソース・バンドルの完全修飾クラス名を設定します。<resource-bundle> で使用されます。 |
サポートされるロケール |
ポートレットが実行時にサポートするロケールを宣言します。<supported-locale> で、
ロケールごとのリソース・バンドル・ファイルの検索に使用されます。 |
ポートレット情報 |
サポートされる各ロケールの、次のようなポートレット情報を指定します。
上記のサポートされるロケールを選択し、選択したロケールのポートレット情報を指定します。
指定した情報は、リソース・バンドル・ファイルに保管されます。
- タイトル
- このポートレットのタイトル・バーに表示されるタイトル。ロケール当たり 1 つのタイトルのみが許可されます。
このタイトルは、ポータルによって、またはプログラム上でポートレットによってオーバーライドされる場合があることに注意してください。デフォルトのロケールの場合は
<portlet-info> の <title> で使用され、
その他のロケールの場合は言語固有のリソース・バンドル・ファイルの javax.portlet.title で使用されます。
- ショート・タイトル
- ショート・バージョンのタイトル。表示機能が制限されているデバイスに使用することがあります。ロケール当たり 1 つのショート・タイトルのみが許可されます。
デフォルトのロケールの場合は <portlet-info> の <short-title> で使用され、
その他のロケールの場合は言語固有のリソース・バンドル・ファイルの javax.portlet.short-title で
使用されます。
- キーワード
- ポートレットの機能を説明するキーワード。ユーザーがキーワードを基にしてポートレットを検索できるようにするポータルは、
これらのキーワードを使用することがあります。1 ロケールに対して複数のキーワードを使用できますが、
コンマ (,) で区切る必要があります。デフォルトのロケールの場合は
<portlet-info> の <keywords> で使用され、
その他のロケールの場合は言語固有のリソース・バンドル・ファイルの javax.portlet.keywords で使用されます。
|
表 4. ポートレット・モードのサポートの定義プロパティー名 |
説明 |
サポートされるモード |
サポートする各マークアップ・タイプのためにポートレットが処理できる、ポートレット・モード。すべてのポートレットは VIEW ポートレット・モードをサポートする必要があります。ポートレットは、指定されたマークアップ・タイプのためにサポートされていると宣言されていないポートレット・モードでは呼び出せません。ポートレット・コンテナーは、ポータル実装によってサポートされていない、またはポータルによってサポートされていないポートレット・モードに対するマッピングがない、カスタム・ポートレット・モードに対するすべての参照を無視します。- MIME タイプ
- ポートレットがサポートする MIME タイプ。<supports> の <mime-type> で使用されます。
- マークアップ
- ポートレットがサポートするマークアップ・タイプ。プロパティー wps.markup を定義するために <init-param> で使用されます。
これは、ポートレットがマークアップ・タイプにアクセスできるようにするための、IBM® 拡張の
マークアップ・プロパティーです。MIME タイプよりもきめ細かいマークアップの
定義です。
たとえば、HTML と cHTML の MIME タイプは両方とも text/html ですが、マークアップ html および chtml は、
ポートレットが HTML と cHTML のケースに別々の出力を生成できるようにします。
この IBM 拡張について詳しくは、「Developing portlets using JSR 168 and WebSphere® Portal
V5.02」を参照してください。
- ポートレット・モード
- ポートレットが MIME タイプで指定されたマークアップ・タイプを処理できる、ポートレット・モード。標準ポートレット・モード (VIEW、EDIT、または HELP)。<supports> の <portlet-mode> で使用されます。
|
表 5. 初期設定パラメータープロパティー名 |
説明 |
初期設定 |
ポートレットの初期設定パラメーターを指定します。
初期設定パラメーターを名前/値のペアとして追加または除去するには、
「追加」または「除去」ボタンをクリックします。
パラメーターとその値を更新するには、
パラメーターを選択し、「編集」ボタンをクリックします。
<init-param> で使用されます。 |
表 6. プログラム上のセキュリティープロパティー名 |
説明 |
セキュリティー役割参照 |
セキュリティー役割参照を指定します。セキュリティー役割参照を追加、除去、
または更新するには、「追加」ボタン、「除去」ボタン、
または「編集」ボタンをクリックします。次のサブエレメントは、<security-role-ref> エレメント内で定義されます。- 役割名
- アプリケーションのセキュリティー役割を参照する役割の名前を指定するストリング。ポートレットは、この役割名を使用して、
認証済みユーザーがアプリケーションのセキュリティー役割に含まれているかどうかを判断します。<role-name> で使用されます。
- 役割リンク
- ユーザーをマップするアプリケーションのセキュリティー役割の名前を指定するストリング。このセキュリティー役割は、Web デプロイメント記述子に
定義する必要があります。Web デプロイメント記述子にすでに定義されているセキュリティー役割を指定する場合は、リストから選択することができます。<role-link> で使用されます。
- 言語
- 説明が記述されている言語。<description> で xml:lang として使用されます。
- 説明
- セキュリティー役割に関する説明テキスト。<description> で使用されます。
たとえば、セキュリティー役割参照 FOO を役割名が
manager のセキュリティー役割にマップするには、「役割名」フィールドで FOO
を指定し、「役割リンク」フィールドで manager を指定します。
この場合、manager セキュリティー役割に属しているユーザーが呼び出すポートレットが、
API 呼び出し isUserInRole("FOO") を行った場合、結果は true になります。 |
キャッシュ
コンテンツのキャッシュは、ユーザーに対する Portal の応答時間の改善に役立ちます。また、サーバーの負荷の削減にも役立ちます。ポートレット仕様書は、有効期限を基にしたキャッシュ・メカニズムを定義しています。
このキャッシュ・メカニズムは、ポートレットごと、ユーザー・クライアントごとのものです。キャッシュされたコンテンツは、
同じポートレットを表示する異なるユーザー・クライアント間では共有できません。
リモート・プロキシー・サーバーがキャッシングに使用される環境では、JSR 168
対応ポートレットは、リモート・プロキシー・サーバー上でページがキャッシングされる方法を判別するために、
サーバーが使用するキャッシュ設定値を指定できます。

表 7. キャッシュプロパティー名 |
説明 |
有効期限付きキャッシュ |
有効期限を基にしたキャッシュ・メカニズムを定義します。
次の選択項目は、
有効期限プロパティー <expiration-cache> の値を設定するために使用されます。- 常時満了
- キャッシュはポートレットに対して使用不可です。これは、有効期限プロパティーに 0 を設定します。
- 常に有効
- キャッシュの有効期限が切れません。これは、有効期限プロパティーに -1 を設定します。
- 指定した秒の経過後に無効
- 有効期限キャッシュの期間 (秒)。
|
リモート・キャッシュ |
デプロイメント記述子拡張 (ibm-portlet-portal-ext.xmi) を使用して、追加設定を指定することもできます。
ポートレットは、拡張ファイル内の <remote-cache-scope> エレメントを使用して、リモート・キャッシュが shared であるか、not-shared であるかを指定します。- リモート・キャッシュ・ダイナミック (Remote cache dynamic)
- ポートレット・ウィンドウで実行時のキャッシュ設定値が変更されない場合、
このチェック・ボックスを選択解除する必要があります。
この設定値はパフォーマンスを最適化し、ポートレット・ウィンドウがリモート・キャッシュ情報を公開するのを待つ必要がないことを、ポートレット・コンテナーに知らせます。この
設定のデフォルトの振る舞い (チェック・ボックスが選択されている) は、
ポートレット・ウィンドウでリモート・キャッシュ情報が公開されることを示します。
- リモート・キャッシュ・スコープ (Remote cache scope)
- shared は、リモート・キャッシュが共用されることを示します。
|
ポートレット設定
ポートレットは、通常、
さまざまなユーザー用のカスタマイズされたビューまたは振る舞いを提供するように構成されます。この構成は、名前と値のペアの永続的な設定として表され、ポートレット設定として参照されます。ポートレット設定は、ポートレットの基本構成データを保管することを目的としています。汎用データベースを置き換えることは、ポートレット設定の目的ではありません。
プロパティー名 |
説明 |
永続的設定 |
ポートレット設定を指定します。設定でエレメントを指定します。<preference> 属性に組み込まれます。- 名前
- 設定の名前。<preference> の <name> で使用されます。
- 値
- 設定の初期デフォルト値。<preference> の <value> で使用されます。
- 読み取り専用
- デプロイメント時にこの設定を修正するには、「読み取り専用」チェック・ボックスを選択します。
これが選択されていない場合、この設定は、ポートレットがアクション要求をいずれかの標準ポートレット・モード・モデル (VIEW、EDIT、または HELP) で処理しているときに変更可能です。この選択は、<read-only> エレメントを <preference> で true に設定します。
設定バリデーター・クラスの選択 - バリデーター・クラス
- PortletPreferences オブジェクト内の設定値のセットを検証するために、PreferencesValidator インターフェースを実装するクラスを指定します。
設定バリデーターを選択するには、「バリデーター・クラス」フィールドを編集するか、「ブラウズ」ボタンをクリックします。<portlet-preferences> 属性の <preference-validator> 属性で使用されます。
|