Oracle PDK-Javaポートレット・ウィザードの使用

Oracle PDK-Javaポートレット・ウィザードはJ2EE Webサーバーへのデプロイ用のJavaポートレットの作成を支援します。必要なディレクトリに必要なすべてのファイルが作成されます。

このウィザードを使用するには、ポートレット・テクノロジ・スコープのプロジェクトをOracle JDeveloperの「アプリケーション・ナビゲータ」で使用可能にする必要があります。このウィザードには次のステップがあります。

ウィザードの起動

Oracle PDK-Javaポートレット・ウィザードを起動する手順は、次のとおりです。

  1. Oracle JDeveloperの「アプリケーション・ナビゲータ」で、プロジェクト(たとえば、ポートレット)を右クリックし、ポップアップ・メニューから「新規」を選択します。
  2. 「新規ギャラリ」の「カテゴリ」で、「Web」ノードを開き「ポートレット」を選択します。

    「ポートレット」が存在しない場合、プロジェクトはポートレットの作成に設定されません。「新規ギャラリ」で「フィルタ方法」ドロップダウン・リストから「すべてのテクノロジ」を選択します。「ポートレット」が「Web」ノードに表示されます。

    注意: プロジェクト・プロパティを編集、および選択したテクノロジのリストに「ポートレット」を追加してプロジェクトのテクノロジ・スコープを定義または修正できます。

  3. 「新規ギャラリ」の「項目」の下で、「Oracle PDK-Javaポートレット」を選択して「OK」をクリックします。
  4. ようこそページで、「次へ」をクリックし、Webアプリケーション・ページまたはポートレットの説明ページへ移動します。

    オプションとして、ようこそページから移動する前に、「次回にこのページを表示しない」チェック・ボックス選択し、このウィザードを次に使用するときにようこそページを表示させないようにできます。

Webアプリケーション・バージョンの選択

注意: このページは、サーブレットのバージョンがプロジェクトのweb.xmlファイルでまだ定義されていない場合に表示されます。

Webアプリケーション・ページを使用して、現在のプロジェクトのファイルで使用するサーブレット・バージョンを指定します。サーブレット・バージョンを指定すると、選択したバージョンがサポートする追加タグ・ライブラリが使用可能になります。

Webアプリケーション・バージョンを選択する手順は、次のとおりです

  1. サーブレット・オプションの1つの隣にあるラジオ・ボタンを選択します。

    次の中から選択します。

  2. 「次へ」をクリックして、ポートレットの説明ページに移動します。

ポートレットの説明の入力

ポートレットの説明ページでは、ポートレットの名前および説明付けし、アプリケーション・ページにポートレットをレンダリングする最大時間を指定します。

ポートレットの説明を入力して、タイムアウト期間を指定する手順は、次のとおりです。

  1. 「ポートレット名」フィールドに、ポートレットの内部名を入力します。
  2. 「表示名」フィールドに、ポートレットのヘッダーで表示する名前を入力します。

    表示名は、Oracle JDeveloperのコンポーネント・パレットなどのポートレット選択リストに使用します。

  3. 「説明」フィールドに、ポートレットの簡単な説明を入力します。

    このポートレット属性は、WebCenterアプリケーションでは実装されませんが、他のアプリケーションで使用されるポートレットでは有用の場合があります。たとえば、OracleAS Portalでこのポートレットを使用する場合、ポートレット・リポジトリのポートレットの下に、説明が表示されます。

  4. 「タイムアウト」フィールドに、ポートレットをレンダリングする値を秒単位で入力します。
  5. 「タイムアウト・メッセージ」フィールドに、ポートレットに必要なレンダリングのタイムアウトを表示するメッセージを入力します。
  6. 「次へ」をクリックして、表示モード・ページに移動します。

ポートレット・モードの選択および定義

ポートレット・モード・ページで、ポートレット・モードの実装スタイルおよびリソースを定義します。「ページを表示」モードは、必須なので選択できません。「ページを表示」モードでは、ブラウザ・ウィンドウに追加のポートレットおよびその他のオブジェクトを表示するスペースを与えるために、ポートレットを小さく表示します。「詳細ページを表示」モードでは、ポートレットはフルブラウザで表示されます。たとえば、「ページを表示」モードのポートレットでは、最後に送信した支出レポートが10件までしか表示されませんが、「詳細ページを表示」モードでは送信した全件が表示されます。

ポートレット・モードを選択および定義する手順は、次のとおりです。

  1. (必須の)「ページを表示」モードでは、ポートレット・モード・ページで次を実行します。

    注意: OC4J制限のため、リソース名にはマルチバイト文字を含めないでください。

    1. 実装スタイルを指定します。

      • 「JSP」を選択して、JavaServer Page(JSP)としてポートレットの「ページを表示」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「ページを表示」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「ページを表示」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「ページを表示」を実装します。
    2. HTTPサーブレットまたはJavaクラスとしてを実装される「ページを表示」の場合、「パッケージ名」フィールドにHTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装される「ページを表示」の場合、「クラス名」フィールドに、ポートレットの「ページを表示」と連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装される「ページを表示」の場合、「ファイル名」フィールドに、ポートレットの「ページを表示」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  2. 「詳細ページを表示」を選択して、ポートレットをフル・ブラウザで表示できるようにします。

    「詳細ページを表示」モードはオプションです。

    注意: OC4J制限のため、リソース名にはマルチバイト文字を含めないでください。

    1. 「詳細ページを表示」モードでは、実装スタイルを次のように指定します。

      • 「JSP」を選択して、JavaServerページ(JSP)としてポートレットの「詳細ページを表示」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「詳細ページを表示」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「詳細ページを表示」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「詳細ページを表示」を実装します。
    2. HTTPサーブレットまたはJavaクラスとして実装されるポートレットの場合、「パッケージ名」フィールドに、HTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装されるポートレットの場合、「クラス名」フィールドに、ポートレットの「詳細ページを表示」と連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装されるポートレットの場合、「ファイル名」フィールドに、ポートレットの「詳細ページを表示」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  3. 「次へ」をクリックして、カスタマイズ・モード・ページに移動します。

カスタマイズ・モードの選択および定義

カスタマイズ・モード・ページでは、ポートレットのカスタマイズ・モード、「ページの編集」および「デフォルト・ページの編集」に関する情報を指定します。カスタマイズ・モードでは、動作の調整方法が提供され、ポートレットの要素が表示されます。

通常、カスタマイズ・モードを使用すると、様々なポートレット設定を調整できます。これらの設定には、ポートレットのタイトル、コンテンツのタイプ、書式設定、表示制限(例: 1つのウィンドウに表示可能なレコード数)、フォーム要素に関するデフォルト、ポートレットの外観またはコンテンツに影響を与える項目などがあります。

両方のモードがオプションです。

カスタマイズ・モードを選択および定義する手順は、次のとおりです。

  1. カスタマイズ・モード・ページで、「ページの編集」を選択し、ユーザーがポートレットの表示動作をカスタマイズできるようにします。

    1. 「ページの編集」の実装スタイルを指定します。

      • 「JSP」を選択して、JavaServer Page(JSP)としてポートレットの「ページの編集」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「ページの編集」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「ページの編集」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「ページの編集」を実装します。
    2. HTTPサーブレットまたはJavaクラスとして実装される「ページの編集」の場合、「パッケージ名」フィールドにHTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装される「ページの編集」の場合、「クラス名」フィールドに「ページの編集」モードと連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装される「ページの編集」の場合、「ファイル名」フィールドに、「ページの編集」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  2. 「デフォルト・ページの編集」を選択して、ブラウザ・ウィンドウに追加のポートレットおよびその他のオブジェクトを表示するスペースを与えるために、ポートレットを小さく表示できるようにします。

    1. 「デフォルト・ページの編集」の実装スタイルを指定します。

      • 「JSP」を選択して、JavaServer Page(JSP)としてポートレットの「デフォルト・ページの編集」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「デフォルト・ページの編集」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「デフォルト・ページの編集」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「デフォルト・ページの編集」を実装します。
    2. HTTPサーブレットまたはJavaクラスとして実装される「デフォルト・ページの編集」の場合、「パッケージ名」フィールドに、HTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装される「デフォルト・ページの編集」の場合、「クラス名」フィールドに、「デフォルト・ページの編集」と連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装される「デフォルト・ページの編集」の場合、「ファイル名」フィールドに、「デフォルト・ページの編集」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  3. 「次へ」をクリックして、追加モード・ページに移動します。

ヘルプおよびバージョン情報モードの選択および定義

追加モード・ページでは、追加ポートレット・モードの「ヘルプ・ページ」および「ページ情報」に関する情報を指定します。

「ヘルプ・ページ」と「ページ情報」はオプションです。

ヘルプ・ページおよびページ情報モードを選択および定義する手順は、次のとおりです。

  1. 追加モード・ページで、「ヘルプ・ページ」を選択して、ポートレットの「ヘルプ・ページ」の組込みができるようにします。

    1. 「ヘルプ・ページ」に実装スタイルを指定します。

      • 「JSP」を選択して、JavaServer Page(JSP)としてポートレットの「ヘルプ・ページ」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「ヘルプ・ページ」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「ヘルプ・ページ」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「ヘルプ・ページ」を実装します。
    2. HTTPサーブレットまたはJavaクラスとして実装される「ヘルプ・ページ」の場合、「パッケージ名」フィールドにHTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装される「ヘルプ・ページ」の場合、「クラス名」フィールドに「ヘルプ・ページ」と連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装される「ヘルプ・ページ」の場合、「ファイル名」フィールドに「ヘルプ・ページ」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  2. 「ページ情報」を選択して、ポートレットの「ページ情報」の組込みができるようにします。

    1. 「ページ情報」に実装スタイルを指定します。

      • 「JSP」を選択して、JavaServer Page(JSP)としてポートレットの「ページ情報」を実装します。
      • 「HTTPサーブレット」を選択して、HTTPサーブレットとしてポートレットの「ページ情報」を実装します。
      • HTTPファイルを選択して、HTMLファイルとしてポートレットの「ページ情報」を実装します。
      • 「Javaクラス」を選択して、Javaクラスとしてポートレットの「ページ情報」を実装します。
    2. HTTPサーブレットまたはJavaクラスとして実装される「ページ情報」の場合、「パッケージ名」フィールドにHTTPサーブレットまたはJavaクラスを含むパッケージの名前を入力します。

      このプロジェクトを所有するアプリケーションの作成時にアプリケーション・パッケージの接頭辞を指定した場合は、このフィールドにその接頭辞がデフォルト値として表示されます。

    3. HTTPサーブレットまたはJavaクラスとして実装される「ページ情報」の場合、「クラス名」フィールドに「ページ情報」と連動して参照するJavaクラスを入力します。
    4. JSPまたはHTMLファイルとして実装される「ページ情報」の場合、「ファイル名」フィールドに「ページ情報」に使用するファイル名を入力するか、デフォルトのファイル名を使用します。
  3. 「次へ」をクリックして、パブリック・ポートレット・パラメータ・ページに移動します。

パブリック・ポートレット・パラメータの追加

パブリック・ポートレット・パラメータ・ページを使用して、Oracle PDK-Javaポートレットで使用される外部パラメータの詳細を提供します。このパラメータ要素は、移入する準備のあるポートレットのページ定義に追加されます。

Oracle PDK-Javaポートレットにパブリック・ポートレット・パラメータを追加する手順は、次のとおりです。

  1. パブリック・ポートレット・パラメータ・ページで「追加」ボタンをクリックします。

    空白行がパラメータ表に追加されます。

  2. ポートレットのページ定義ファイルで使用するパラメータ名を「名前」列に入力します。使用するのは、文字、数字およびアンダースコアのみです。
  3. 「表示名」列で、ユーザーに表示するパラメータ名を入力します。
  4. 「説明」列で、パラメータの説明情報を入力します。
  5. ステップ1からステップ4を繰り返してさらにパラメータを追加します。
  6. 「次へ」をクリックして、パブリック・ポートレット・イベント・ページに移動します。

パブリック・ポートレット・イベントの追加

注意: ポートレット・イベントはOracle Portal 10gの機能ですが、Oracle WebCenter Frameworkアプリケーションには影響ありません。

このページは使用して、Oracle PDK-Javaポートレットが必要なアクションのトリガーに使用するイベントの詳細を提供したり、名前付きイベントと関連付けられたパラメータを識別するのに使用します。ポートレット・ウィザードは、イベントおよびイベント・パラメータに必要なエントリを生成しますが、ポートレットの「ページを表示」モードのサンプル・コードは生成しません。

注意:WebCenterアプリケーション・ページまたはポータル・ページに関連付けるイベントおよびパラメータに関するコードのサンプルおよび情報は、Oracle Technology Network(http://portalcenter.oracle.com/documentation)のポータルの項にあるOracle Application Server Portal開発者ガイド、およびOracle WebCenter Framework開発者ガイドを参照してください。

このページのイベントとパラメータの表には、マスター/ディテール関係があります。複数イベントを作成し、イベントの1つを選択し、選択されたイベントと関連付けるパラメータを追加します。2番目のイベントを選択しても、最初のイベントに関連付けられたパラメータはパラメータ表に表示されません。このように特定のイベントに1以上のパラメータを関連付けることができます。

Oracle PDK-Javaポートレットにパブリック・ポートレット・イベントを追加する手順は、次のとおりです。

  1. パブリック・ポートレット・イベント・ページで、イベント表の下にある「追加」ボタンをクリックします。

    空白の行がイベント表に追加されます。

  2. 「名前」列で、イベント名を入力してポートレット・イベントを識別します。

    イベント名は、ポートレット内で一意である必要があり、文字、数字およびアンダースコアのみを含むことができます。

  3. 「表示名」列に、イベント名を入力し、ユーザーに表示します。

    「表示名」を入力して、OracleAS Portal 10gに使用する属性名を作成します。属性名は「ポータル」のイベント・マッピング・インタフェースで使用されます。

  4. 「説明」列に、イベントの説明情報を入力します。
  5. ステップ1から4を繰り返して、さらにイベントを追加します。

イベントにパラメータを関連付ける手順は、次のとおりです。

  1. イベント表でイベントを選択して、パラメータ表の下にある「追加」ボタンをクリックします。

    空白行がパラメータ表に追加されます。

  2. 「名前」列に、パラメータの内部名を入力し、選択したイベントに関連付けます。

    この名前は、ポートレットのページ定義ファイルに追加されます。パラメータ名はポートレット内で一意である必要があり、文字、数字およびアンダースコアのみを含むことができます。

  3. 「表示名」列に、パラメータの表示名を入力します。

    「表示名」を入力して、OracleAS Portal 10gに使用する属性名を作成します。属性名は「ポータル」のイベント・マッピング・インタフェースで使用されます。

  4. 「説明」列で、パラメータの説明情報を入力します。
  5. ステップ1からステップ4を繰り返してさらにパラメータを追加します。
  6. 別のイベントにパラメータを関連付けるには、イベントを選択して、ステップ1から4を繰り返します。
  7. 「次へ」をクリックして、プロデューサの説明ページに移動します。

ポートレット・プロデューサの説明

このページを使用して、Oracle PDK-Javaポートレット、およびポートレットの正常な実行およびデプロイに必要な追加ファイルのプロデューサ定義ファイル(provider.xml)を生成します。provider.xmlファイルは、「アプリケーション・ナビゲータ」のWEB-INF¥providers¥<producer_name>ノードの下に表示されます。

ポートレット・プロデューサを説明する手順は、次のとおりです。

  1. プロデューサの説明ページで、「プロデューサ名」フィールドにポートレット・プロデューサの名前を入力します。

    この名前は、アプリケーション内で一意である必要があります。文字、数字およびアンダースコアのみが使用できます。

  2. 「デプロイ・プロパティ・ファイルの生成」チェック・ボックスを選択して、Oracle JDeveloperで2つのプロパティ・ファイルを自動生成します。

  3. 「XMLエントリの生成」チェック・ボックスを選択して、「アプリケーション・ナビゲータ」のWEB-INF¥providers¥<ProviderName>ノードの下にあるprovider.xmlファイルを自動生成します。

    これは、プロディーサに属しているポートレットの詳細を含むプロデューサ定義ファイルで、ウィザードにより生成されたポートレットを含みます。

  4. 「索引JSPの生成」チェック・ボックスを選択して、index.jspファイルを自動生成します。

    index.jspファイルは、「アプリケーション・ナビゲータ」のWEB-INF¥providers¥<provider_name>ノードの下に生成されます。index.jspファイルは、プロデューサ・テスト・ページに簡単にアクセスできるハイパーリンクがあるWebアプリケーションのすべてのプロデューサをリストします。

ウィザードの終了

Oracle PDK-Javaポートレット・ウィザードを終了する手順は、次のとおりです。

「終了」をクリックして、Oracle PDK-Javaポートレットの開発に必要なファイルの作成を完了します。


Oracle WebCenter Frameworkの使用
JSR 168およびOracle PDK-Javaポートレットについて
Oracle PDK-Javaポートレットの編集
アプリケーション・ページからのポートレットの削除