規格に基づいたJavaポートレット(JSR 168)ウィザードの使用

規格に基づいたJavaポートレット(JSR 168)ウィザードは、WSRPで使用可能なWebサーバーのデプロイメントに対するJavaポートレットの作成を支援します。このウィザードは、必要なディレクトリですべての必要なファイルを作成します。

WebCenterアプリケーションのポートレット・プロジェクトと併用してこのウィザードを使用するのが理想的です。だたし、ポートレットを作成するプロジェクトが、ポートレット・テクノロジ・スコープを含むか、またはポートレット作成のために十分にスコープされている場合は、どのようなアプリケーションでもポートレットを作成できます。

規格に基づいたJavaポートレット(JSR 168)ウィザードを使用するには、次の手順があります。

ウィザードの起動

ウィザードを起動する手順は、次のとおりです。

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

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

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

  3. 「新規ギャラリ」の「項目」で、「規格に基づいたJavaポートレット(JSR 168)」を選択して、「OK」をクリックします。
  4. ようこそページで、「次へ」をクリックして、Webアプリケーションまたは一般ポートレット・プロパティ・ページに移動します。

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

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

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

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

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

    次の中から選択します。

  2. 「次へ」をクリックして、一般ポートレット・プロパティ・ページに移動します。

一般ポートレット・プロパティの構成

一般ポートレット・プロパティを構成する手順は、次のとおりです。

  1. 「クラス名」フィールドに、ウィザードで作成するJavaクラスの名前を入力します。

    このフィールドには、受け入れるか、または変更するデフォルトのクラス名が含まれます。クラスは有効なJava名である必要があります。

  2. 「パッケージ」フィールドに、ステップ1で名前を付けたクラスが存在するパッケージ名を入力します。

    オプションで、「参照」をクリックして、パッケージを検索して選択します。パッケージを選択しない場合、ウィザードはプロジェクトのデフォルト・パッケージを使用します。パッケージは、有効なJava名である必要があります。

  3. 「デフォルトの言語」ドロップダウン・リストから、ポートレットのデフォルト言語を選択します。
  4. 「このポートレットはユーザーによる編集が可能ですか。」で、「編集可能」チェック・ボックスを選択して、ポートレットの編集を可能にします。

    「編集可能」チェック・ボックスを選択して、editモード(ユーザーがポートレットの個別表示を調整できる「パーソナライズ」に該当します)を追加して、ユーザーがedit_defaultモード(サイト管理者がすべてのユーザーの表示に影響するポートレットを変更できる「カスタマイズ」に該当します)を追加できるようにします。

    ウィザードでは、このオプションはデフォルトで選択されています。

  5. 「このポートレットはOracle WSRP 2拡張機能をサポートしますか。」で、WSRP V2のポートレット間通信を可能にするチェック・ボックスを選択し、このポートレットでOracle WSRP 2.0拡張機能を使用できるようにします。

    このオプションを選択して、ナビゲーション・パラメータなどのWSRP 2.0機能に使用するoracle-portlet.xmlファイルを作成します。WSRP 2.0標準では、(ナビゲーション・パラメータを介した)ポートレット間通信およびポートレット・カスタマイズのエクスポートやインポートのサポートを含むことで、WSRP 1.0を拡張します。Oracle拡張機能で作成されたJSR 168ポートレットは、WSRP 2.0をサポートするコンシューマで使用されます。WSRP 2.0を使用するには、ポートレットをOracle JSR 168ポートレット・コンテナ(OC4J)にデプロイする必要があります。

    ウィザードでは、このオプションがデフォルトで選択されています。WSRP 2.0ポートレットはWSRP 1.0クライアントから実行できます。ただし、この場合WSRP 2.0機能は使用できません。

  6. 「次へ」をクリックして、名前と属性ページに移動します。

名前および検索条件の指定

このページを使用して標準Java JSR 168ポートレットの名前および説明付けし、検索を使用したときにポートレットの場所がわかるキーワードを定義します。

ポートレット名を指定し、検索項目を割り当てる手順は、次のとおりです。

  1. 「表示名」フィールドに、ポートレットの名前を入力します。

    「表示名」に入力した値は、portlet.xmlファイルでポートレットの一意の識別子として使用されます。

  2. 「ポートレット・タイトル」フィールドに、ポートレット・ヘッダーおよびOracle JDeveloperコンポーネント・パレットで表示されるタイトルを入力します。
  3. 「短いタイトル」フィールドに、PDAおよび携帯電話などの限られた表示スペースのクライアントで表示されるタイトルを入力します。

    ポートレット属性は、モバイル・オプションをサポートしないWebCenterアプリケーションでは実装されませんが、他のアプリケーションで使用されるポートレットでは有用の場合があります。たとえば、OracleAS Portalでこのポートレットを使用し、モバイル・オプションをユーザーに提供することを計画している場合、ポートレットに短いタイトルを入力して、長いポートレット・タイトルのかわりに、ポートレット・ヘッダーで表示します。

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

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

  5. 「キーワード」フィールドに、このポートレットまたはこのポートレットが提供する機能のタイプの検索時に使用するキーワードを入力します。

    カンマで複数のエントリを区切ります。

    このポートレット属性は、WebCenterアプリケーションでは実装されませんが、他のアプリケーションで使用されるポートレットでは有用の場合があります。

  6. 「次へ」をクリックして、コンテンツ・タイプとポートレット・モード・ページに移動します。

許容可能なコンテンツ・タイプの設定および表示モードのマッピング

このページで、ポートレットのコンテンツ・タイプおよび表示モードを選択し、ポートレット・モードを実装メソッドにマップします。デフォルトでは、ポートレットにはViewのコンテンツ・タイプおよびポートレット・モードとしてtext/htmlが表示されます。一般ポートレット・プロパティ・ページで「編集可能」を選択した場合、editもtext/htmlのポートレット・モードとして表示されます。

許容可能なポートレット・コンテンツ・タイプの設定して、表示モードおよび実装メソッドを選択する手順は、次のとおりです。

  1. デフォルト(text/html)以外のコンテンツ・タイプを追加するには、text/htmlを選択し、「追加」ボタンをクリックします。
  2. 「コンテンツ・タイプ」ダイアログ・ボックスで、「選択可能」リストからコンテンツ・タイプを選択して、追加(ALT-D)をクリックして「選択済」リストに移動します。

    複数のコンテンツ・タイプを選択する手順は、次のとおりです。

    リストされたすべてのコンテンツ・タイプを選択して、すべて移動(ALT-L)をクリックします。

    次のコンテンツ・タイプを選択できます。

    コンテンツ・タイプ 説明
    text/html テキストのHTMLエンコードをサポートします。これはデフォルトで選択されています。
    text/xml テキストのXMLエンコードをサポートします。
    text/plain エンコードされていないプレーン・テキストをサポートします。
    text/vnd.oracle.mobilexml

    テキストのOracle Mobile XMLエンコードをサポートします。

    ただし、Oracle WebCenter Frameworkではモバイル・サポートは提供されていません。

    application/xhtml+xml このポートレットは、XHTMLでエンコードされたテキストをサポートします。このコンテンツ・タイプは、すべてのブラウザでサポートされるわけではありません。
    application/xml このポートレットは、XHTMLを含むXMLコンテンツをサポートします。

    オプションで、「コンテンツ・タイプ」ダイアログ・ボックスで、「新規タイプ」ボタンをクリックして、ポートレットに新規コンテンツ・タイプの名前を追加します。

    各コンテンツ・タイプは、少なくとも1つのデフォルトの表示モード、viewが用意されています。

  3. 追加表示モードを特定のコンテンツ・タイプに追加するには、コンテンツ・タイプにリストされる表示モードを選択し、「追加」ボタンをクリックします。
  4. 「ポートレット・モード」ダイアログ・ボックスで、「選択可能」リストからポートレット・モードを選択して、追加(ALT-D)をクリックし、「選択済」リストに移動します。

    複数のモードを選択する手順は、次のとおりです。

    リストされたモードをすべて選択するには、すべて移動(ALT-L)をクリックします。

    次のポートレット・モードを選択できます。

    ポートレットの表示モード 説明
    view ポートレットを表示する表示モードを定義します。
    edit ポートレット・インスタンスの表示設定の表示モードを定義します。このモードは前のステップのウィザードで「編集可能」を選択した場合にのみ使用できます。WebCenterアプリケーションでは、editモードは「パーソナライズ」コマンドとしてポートレットの「アクション」メニューに表示されます。
    help ポートレットのヘルプ・コンテンツの表示モードを定義します。
    about ポートレットの概要コンテンツの表示モードを定義します。
    config

    ポートレットの構成設定の表示モードを定義します。

    このモードの使用はユーザーの任意です。実装可能な選択の1つはデータベースの接続詳細の設定のモードです。

    edit_defaults ポートレットのプロパティの表示モードを定義します。WebCenterアプリケーションで、edit_defaultsモードは「カスタマイズ」コマンドとしてポートレットの「アクション」メニューで表示されます。
    preview

    ポートレットのプレビューの表示モードを定義します。

    このモードは、WebCenterアプリケーションにおいては常に役立つわけではありません。しかし、これはOracleAS Portalに実装されます。Portalではユーザーがポートレット・リポジトリの拡大アイコンをクリックし、リストされたポートレットをプレビューします。

    print プリンタ用のポートレットの表示モードを定義します。
  5. 各ポートレット・モードに実装メソッドを定義するには、「コンテンツ・タイプ」および「ポートレット・モード」リストでモードを選択し、実装メソッドの隣にあるラジオ・ボタンを選択して、選択したモードに使用します。

    次の中から選択します。

  6. 「次へ」をクリックして、カスタマイズ・プリファレンス・ページに移動します。

ユーザー・パーソナライズ可能プリファレンスの指定

ポートレットを編集できる初期のステップで、カスタマイズ・プリファレンス・ページがウィザードに表示されます。このページを使用して、各プリファレンスに対するデフォルト値を提供する、実行時にユーザーがパーソナライズできるプリファレンスを指定し、プリファレンスが変換されたかどうかを表示します。

カスタマイズ・プリファレンス・ページには、適切な位置のポートレット・タイトルにデフォルトのプリファレンスが用意されています。デフォルトのポートレット・タイトルのプリファレンスは削除できません。

ユーザー・パーソナライズ可能プリファレンスを指定する手順は、次のとおりです。

  1. カスタマイズ・プリファレンス・ページで、「追加」ボタンをクリックして、新規パーソナライズ・プリファレンスを追加します。
  2. 「新規プリファレンスの追加」ダイアログで、「名前」フィールドにプリファレンスの名前を入力します。

    名前はポートレット内で一意である必要があります。文字、数字およびアンダースコアのみを使用します。

  3. 「デフォルト値」フィールドに、このプリファレンスに対して、2つ以上のデフォルト値を入力します。

    カンマで複数のエントリを区切ります。

  4. 「このプリファレンスを翻訳しますか。」で、プリファレンスを追加言語に翻訳する場合、「翻訳」チェック・ボックスを選択します。

    このオプションを選択した場合、リソース・バンドル・クラスは開発者が翻訳を取得した文字列で生成されます。実行時では、ポートレットはリソース・バンドル・エントリを参照します。

  5. 「OK」をクリックします。

    「プリファレンス詳細」で新規に入力されたプリファレンスを表示します。「プリファレンス詳細」セクションを使用して、選択したプリファレンスの値を修正します。

  6. カスタマイズ・プリファレンス・ページで、「次へ」をクリックして、セキュリティ・ロール・ページに移動します。

セキュリティ・ロールの追加

セキュリティ・ロール・ページを使用して、セキュリティ・ロールを選択し、現在のポートレットに新規セキュリティ・ロールを追加します。ポートレット・プロデューサの登録時に、WebCenterアプリケーションで定義されたJ2EEセキュリティ・ロールを使用して宣言したセキュリティ・ロールがマップできます。

セキュリティ・ロールを使用すると、ポートレットに階層レベルのアクセスを設定できます。たとえば、表示ユーザーはポートレットを表示できますが、編集はできません。カスタマイズ・ユーザーはポートレットの設定をカスタマイズできます。管理ユーザーはポートレットに関連付けられている使用可能なすべての機能を実行できます。ポートレット開発者は、これらのロールの権限と制限を定義するロジックを提供します。

セキュリティ・ロールを追加する手順は、次のとおりです。

  1. セキュリティ・ロール・ページで、「新規セキュリティ・ロール」ボタンをクリックして、「新規セキュリティ・ロールの作成」ダイアログ・ボックスを開きます。
  2. 「名前」フィールドに、セキュリティ・ロールの一意の名前を入力します。

    使用できるのは文字、数字、アンダースコアのみです。

  3. 「説明」フィールドに、新規セキュリティ・ロールの説明を入力します。

    アクセス権限およびこのセキュリティ・ロールの新規ポートレットに対する制限を記述するのが理想的です。

  4. 「OK」をクリックします。

    セキュリティ・ロールは、このポートレット・アプリケーションのポートレットで、現在使用可能です。

  5. セキュリティ・ロールをポートレットに追加するには、「選択可能」リストで選択し、移動(ALT-D)をクリックして「選択済」リストに移動します。

    「選択可能」および「選択済」リストで、選択したセキュリティ・ロールの詳細が、「セキュリティ・ロール詳細」に表示されることに注意してください。

  6. 「次へ」をクリックして、キャッシュ・ページに移動します。

デフォルトのキャッシュの有効化

キャッシュ・ページを使用して、ポートレットを2番目および後続のリクエストの高速のレンダリングに対して、デフォルトでキャッシュするかどうかを指定します。このオプションを選択するとポートレットのキャッシュは、ポートレット・コンテナで管理されることを示します。ポートレット自体は、特定のレスポンスにキャッシュするコンテンツを選択できます。ポートレット自体がキャッシュの条件を指定しない場合のみ、このページの設定は適用されます。

デフォルトのキャッシュを使用可能にする手順は、次のとおりです。

  1. キャッシュ・ページで、「キャッシュ」ラジオ・ボタンを選択します。
  2. デフォルトの終了条件を指定して、キャッシュしたコンテンツをいつリフレッシュするかを示します。

  3. 「次へ」をクリックして、初期化パラメータ・ページに移動します。

初期化パラメータの追加

初期化パラメータ・ページを使用して、標準JSR 168ポートレットの初期化に必要なパラメータを指定します。初期化パラメータは、JNDI(Java Naming and Directory Interface)変数のかわりを提供します。JNDIのかわりに初期化パラメータを使用して、サーブレットおよび他のポートレットなどの、ポートレットの異なるコンポーネントのすべての動作を互換性のある方法で構成します。

作成されたパラメータは「アプリケーション・ナビゲータ」の<project_name >/Web Content/WEB-INFの下のportlet.xmlファイルに入力されます。portlet.xmlファイルをJDeveloperの「エディタ」ウィンドウで開くと、パラメータはOracle JDeveloperの構造ビューで簡単にアクセスできます。

初期化パラメータを追加する手順は、次のとおりです。

  1. 「新規」ボタンをクリックして、パラメータの表に入力行を追加します。
  2. 「名前」列で、新規行をダブルクリックして、初期化パラメータの名前(rowsDisplayedなど)を入力します。

    名前はポートレット内で一意である必要があります。文字、数字およびアンダースコアのみを使用します。

  3. 「値」列をダブルクリックして、初期化パラメータの値を入力します。

    たとえば、rowsDisplayedでは、ポートレットが最初に10行を表示することを意味する10を入力する必要があります。

  4. 「説明」列をダブルクリックして、初期化パラメータの説明を入力します。

    初期化時に表示するポートレットの行の数など、パラメータの使用方法の理解に役立つ説明をportlet.xmlファイルに入力します。

  5. 「次へ」をクリックして、ナビゲーション・パラメータ・ページに移動します。

ナビゲーション・パラメータの追加

ナビゲーション・パラメータ・ページを使用して、JSR 168ポートレットで使用される外部パラメータの詳細を入力します。WSRPコンテナのナビゲーション・パラメータを、JSRポートレット・コードのレンダリング・パラメータと同じ名前でマップします。ポートレットのレンダリング・パラメータをコンシューマにエクスポートして、ポートレット間の通信およびポートレットへのアプリケーション・ページ・プロパティの送信を可能にします。ナビゲーション・パラメータは、ポートレット使用アプリケーションへのポートレットで公開されます。コンシューマはパラメータ値を格納、管理して、パラメータ値を起動するたびにポートレットに送信します。ナビゲーション・パラメータにはWSRP 2.0機能があります。

ナビゲーション・パラメータをJSR 168ポートレットに追加する手順は、次のとおりです。

  1. ナビゲーション・パラメータ・ページで、「追加」ボタンをクリックします。

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

  2. 「名前」列に、パラメータの修飾名を入力します。
  3. 「ラベル」列に、パラメータのラベルを入力します。

    この値はローカライズ可能です。

  4. オプションで、「ヒント」列にパラメータのヒントを入力します。

    この値はローカライズ可能です。

  5. ステップ1からステップ4を繰り返してさらにパラメータを追加します。
  6. 「次へ」をクリックして、ウィザードの最後のページに移動します。または、「終了」をクリックして、ウィザードを終了し、portlet.xmlファイルおよび他の関連したファイル・システム・オブジェクトを生成します。

ウィザードの終了

「終了」をクリックして、ウィザードを終了し、portlet.xmlファイルおよび他の関連したファイル・システム・オブジェクトを生成します。


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