ポートレット・プロジェクトの作成 (JSR 168)

ポートレット・プロジェクト (JSR 168) の JSR 168 ポートレット API を使用して、ポートレット・アプリケーション用のリソースを作成および保守することができます。 ポートレット・プロジェクトは、新規または既存のエンタープライズ・アプリケーション・プロジェクトに追加できます。

特殊なポートレットの作成についての追加情報は、次のトピックを参照してください。
JSR 168 ポートレット・プロジェクトには、次の制限が存在します。
  • 一部の JSR 168 ポートレット API カスタム・タグ (<namespace><actionURL> など) は、Faces ポートレット JSP ファイルの <view> タグ内では使用できません。 Faces ポートレット JSP ファイルの「断片」ビューからの断片は、<view> タグの後に挿入する必要があります。
  • <actionURL> の「portletMode」属性を使用してポートレット・モードを変更すると、Faces ポートレットはデータの保管やアクションの呼び出しを行うことができません。 その代わりに、Faces アクションで ActionResponse#setPortletMode() を使用して、ポートレット・モードを変更してください。

新規 JSR 168 ポートレット・プロジェクトを作成するには、次の手順に従います。

  1. 「ファイル」 > 「新規」 > 「プロジェクト」と選択する。 次に、右側の「ポートレット・プロジェクト (JSR 168)」オプションを選択してから、 「次へ」ボタンをクリックする。 「新規ポートレット・プロジェクト」ウィザードが起動します。
  2. 必要に応じて、次のフィールドに値を入力する。
    プロジェクト名
    新規ポートレット・プロジェクトの名前
    プロジェクト・ロケーション
    プロジェクトが作成されるファイル・システムのロケーション。 ファイル・システムのロケーションは、「ブラウズ」を使用して変更できます。
    WebSphere® Portal バージョン
    ポートレット・プロジェクトに適切な WebSphere Portal バージョンを選択します。 選択によって、ご使用の開発環境に適切なサーブレットおよび対応するターゲット・ サーバーが設定されます。
    ポートレットの作成
    プロジェクトで初期ポートレット定義を作成したくない場合は、このチェック・ボックスをクリアしてください。 通常、ポートレット WAR ファイルをプロジェクトにインポートする場合は、ポートレットを作成する必要はありません。
    プロジェクトの J2EE 設定値を設定するか、プロジェクトのターゲット・ランタイム・サーバーを指定するには、 「拡張を表示>>」ボタンをクリックします。
    注: 上記の「WebSphere Portal バージョン」値を 選択すると、「サーブレット・バージョン」「ターゲット・サーバー」の 両方が適切な値に設定されます。これらの 2 つのフィールドを編集することは お勧めできません
    次の値を指定してください。
    サーブレット・バージョン
    ポートレット・アプリケーションに組み込むサーブレット仕様と JSP 仕様のバージョンを指定します。 デフォルトのバージョン 2.3 には、サーブレット仕様レベル 2.3 および JSP 仕様レベル 1.2 が含まれます。 このデフォルト値は、WebSphere Portal 5.0 または 5.1 サーバーを対象にするポートレット・プロジェクトを作成する場合に使用してください。

    サーブレット・バージョンにより、ドロップダウン・リストに表示されるターゲット・サーバーの選択項目が決まることに注意してください。

    ターゲット・サーバー
    ポートレット・アプリケーションがインストールされる先の WebSphere Portal のバージョンを選択します (WebSphere Portal v5.0 または v5.1)
    注: 誤って WebSphere Application Server オプションのいずれかを選択しないようにしてください。
    EAR プロジェクトにモジュールを追加
    ポートレットをデプロイしない場合のみ、このチェック・ボックスの選択を解除してください。
    EAR プロジェクト
    デプロイメント目的のために、ポートレット・プロジェクトと関連付ける必要があるエンタープライズ・アプリケーション・プロジェクト (EAR プロジェクト) の名前。 テスト環境で WebSphere Portal へポートレット・プロジェクトをデプロイするのに使用される情報は、このプロジェクトで追加されます。 単一 EAR プロジェクトと関連付けられたポートレット・アプリケーションはすべて、テスト環境では単一セッションで実行されます。 ポートレット・アプリケーションを複数の EAR プロジェクトに分割することができます。関連のあるその他のプロジェクトには、同じ EAR プロジェクトを使用する必要があります。
    コンテキスト・ルート
    ポートレット・プロジェクトのコンテキスト・ルート。 テスト環境でポートレット・プロジェクトが WebSphere Portal にデプロイされる場合に、ポートレット・アプリケーションのトップレベル・ディレクトリーとして使用されます。 これは、他のプロジェクトが使用するコンテキスト・ルートと同じであってはなりません。
    注釈付き Java™ クラスのサポートの追加
    モデル注釈を使用してプロジェクトのコードを生成する予定である場合は、このチェック・ボックスが選択されていることを確認してください。

    基本 JSR 168 ポートレット・プロジェクトに関連したデフォルトをそのまま使用する場合は、「完了」をクリックします。 プロジェクト・オプションをカスタマイズするか、異なるタイプのポートレットが使用可能なプロジェクトを作成したい場合は、「次へ」をクリックします。

  3. ポートレット・プロジェクトに該当するポートレットのタイプを選択する。 ポートレットのタイプについて詳しくは、ポートレットおよびポートレット・プロジェクトの作成を参照してください。
    空のポートレット
    最小限のコードを組み込んで GenericPortlet クラスを拡張するポートレット・アプリケーションを作成します。 新規ポートレット・アプリケーションを始めから作成する場合には、空のポートレット・プロジェクトのカスタマイズを参照してください。
    基本ポートレット
    PortletAdapter クラスを拡張する基本ポートレット・アプリケーションを作成します。 これは、コンクリート・ポートレットおよびコンクリート・ポートレット・アプリケーションを備えた完全なアプリケーションです。 これには PortletAdapter クラスを拡張するポートレット・クラス、ポートレットのレンダリングに使用されるサンプル JSP ファイル、およびサンプル Java Bean が組み込まれています。 これらの基本リソースに加えて、追加のウィザード・オプションを指定するときに、ポートレット・アプリケーションが頻繁に使用する機能の サンプル・コードを、プロジェクトに追加することができます。
    Faces ポートレット
    Faces ポートレット・アプリケーションを作成します。詳細については、Faces ポートレット・プロジェクトの作成を参照してください。
    Struts ポートレット
    Struts ポートレット・アプリケーションを作成します。詳細については、Struts ポートレット・プロジェクトの作成を参照してください。
  4. 必要に応じて 1 つ以上の「Web プロジェクト・フィーチャー」を選択する。 基本ポートレットまたは空のポートレットを作成する場合は、「Web ダイアグラム」チェック・ボックスの選択を解除します。 WebSphere Portal が JSP 標準タグ・ライブラリー (JSTL) のタグの使用をサポートする方法について 詳しくは、WebSphere Portal InfoCenter の「ポータル JSP での JSTL タグの使用」を参照してください (WebSphere Portal 製品資料を参照)。
  5. 「次へ」をクリックする。
  6. 「ポートレットの設定」ページでその他のポートレット設定を更新または追加し、「次へ」をクリックする。 (これらのオプションの詳細については、ポートレット・プロジェクトの作成 (IBM API)を参照してください。) 空のポートレットの作成の場合、「次へ」をクリックすると、ただちにウィザードの「各種」ページにスキップします。 「完了」をクリックして空のポートレットを作成する場合、ウィザードは、デプロイメント記述子と適切なフォルダー構造をもつ空のプロジェクト・コンテナーを作成します。 ポートレット・アプリケーションを完成させるには、新しい空のポートレット・プロジェクトをカスタマイズする必要があります。 空の JSR 168 ポートレット・プロジェクトのカスタマイズを参照してください。
  7. 「アクションおよび設定」ページで、ポートレットのアクションおよび設定の処理を定義する。
    アクション要求ハンドラーの追加
    このオプションは、アクション要求を処理するための processAction メソッドを実装します。ポートレット・アクションと関連のある HTTP 要求が受信されると、 アクション要求ハンドラーが起動されます。
    フォーム・サンプルの追加
    このオプションは、表示パネルのフォーム・サンプルを追加します。
    設定処理の追加
    このオプションは、設定を表示パネルに表示します。また、ポートレット設定を変更するための編集パネルも表示します。ポートレット設定は永続的データとして保管され、 パーソナライズされた設定に使用されることがあります。
    設定バリデーターの追加
    このオプションは、設定を検証するための設定バリデーター・クラスを追加します。
  8. 「次へ」をクリックする。
  9. ターゲット・サーバーとして WebSphere Portal v5.1 を選択した場合は、「シングル・サインオン」ページで、クリデンシャル・ボールト処理をサポートするサンプル・コードを追加することができます。 これにより、ユーザーとアドミニストレーターは認証用のクリデンシャルを安全に保管できます。 クリデンシャル・ボールト処理について詳しくは、WebSphere Portal Information Center の「ポートレットの認証」を参照してください。
    クリデンシャル・ボールト処理の追加
    このオプションを選択して、クリデンシャル・ボールト処理をサポートします。 WebSphere Portal は、ユーザーとアドミニストレーターが認証用のクリデンシャルを安全に保管できる、クリデンシャル・ボールトの使用をサポートします。 ボールトからユーザーのクリデンシャルを取り出すために作成されたポートレットは、ユーザーからのログイン確認を隠すことができます。 以下のボールト・スロット・タイプのいずれかを選択してください。
    ポートレットのプライベート (個人用) クリデンシャル・ボールト・スロットの使用
    ポートレット・プライベート (個人用) スロットは、ポートレット間で共用されないユーザー・クリデンシャルを保管します。
    共用クリデンシャル・ボールト・スロットの使用
    共用スロットは、ユーザーのポートレット間で共用されるユーザー・クリデンシャルを保管します。
    管理クリデンシャル・ボールト・スロットの使用
    各ユーザーは、管理スロットを使用してアドミニストレーター定義のリソース (たとえば、Lotus Notes®) にアクセスするための機密情報を保管できるようになります。
    システム・クリデンシャル・ボールト・スロットの使用
    システム・スロットは、実際の機密情報がすべてのユーザーとポートレット間で共用されるシステム・クリデンシャルを保管します。
    スロット名
    ユーザー・クリデンシャルの保管や取り出しができるように、クリデンシャル・ボールト・スロットの名前を定義します。
    パスワードの表示
    このオプションを選択すると、画面上にパスワードが表示モードで表示されます。
    「次へ」をクリックする。
  10. 「各種」ページで、 プロジェクトでポートレットに対して使用可能にしたい追加のマークアップとモードを指定する。
    • すべてのポートレット・アプリケーションでサポートされる HTML マークアップは、常時ウィザードで生成されます。
    • このウィザードは、IBM® 拡張 wps.markup を使用してポートレット・プロジェクトを生成します。この拡張により、ポートレットで純粋な MIME タイプより詳細なマークアップの区別が可能になります。 この IBM 拡張について詳しくは、「Developing portlets using JSR 168 and WebSphere Portal V5.02」を参照してください。
    • 表示モードは、常に選択されています。
    • 編集モードは、「アクションおよび設定」ページで「設定処理の追加」オプションが選択されている場合、 生成されたポートレットに自動的に追加されます。
  11. 「完了」をクリックして、新規ポートレット・プロジェクトを作成する。
  12. 「パースペクティブ切り替えの確認」ダイアログ・ボックスが表示されたら、「はい」をクリックする。 毎回このプロンプトを表示したくない場合は、「このメッセージを再び表示しない」チェック・ボックスを選択します。
  13. ポートレット構成パラメーターの一部には、デフォルト値が割り当てられます。 ポートレット・デプロイメント記述子を編集してこれらの値を再構成するには、JSR 168 ポートレットのカスタマイズを参照してください。 選択に応じて、サンプル JSP ファイルを含むサンプル・ポートレットが生成されます。 ポートレット・プロジェクトにさらにポートレットを追加するには、ポートレットの作成を参照してください。 ポートレット JSP ファイルを追加するには、ポートレット JSP ファイルの作成を参照してください。
関連概念
ポートレットおよびポートレット・プロジェクトの作成
ポートレット・デプロイメント記述子の処理
マークアップ言語
関連タスク
JSR 168 ポートレットのカスタマイズ
ポートレットの作成
ポートレット JSP ファイルの作成
空の JSR 168 ポートレット・プロジェクトのカスタマイズ

(C) Copyright IBM Corporation 2000, 2005. All Rights Reserved.
(C) Copyright IBM Japan 2005