第19章

ポートレットについて

この章では、exteNd Directorでカスタムポートレットを開発および実行する方法を説明します。この節は、次のトピックで構成されています。

ドキュメントタイプの作成

この節では、exteNd Directorポータルで実行するポートレットクラスを作成するいくつかの方法について説明します。ページフローデザインツールやポートレットウィザードのようなexteNd Directorポートレット開発ツールを使用する場合は、次の操作が自動的に実行されます。

ポートレット展開記述子が更新されます
ポートレット定義が作成され、exteNd Directorポータルに登録されます
初期設定がポートレットクラスに定義されているデフォルト値に設定されます
ポートレットは動的にサーバにロードされるため、アプリケーションを再展開せずにロジックをテストできます

ページフローデザインツールの使用

exteNd Directorでは、ページフローと呼ばれる特殊なポートレットを、Javaコーディングせずに作成できる設計ツールが用意されています。

ページフローについての詳細、およびこれらの設計ツールの使用方法については、Pageflow and Form Guideを参照してください。

ポートレットウィザードの使用

ポートレットウィザードを使用すると、exteNd DirectorのJava Portlet 1.0拡張機能を利用できるJava Portlet 1.0互換ポートレットが作成できます。

ポートレットウィザードを使用したポートレットの作成

Procedure ポートレットウィザードを使用してカスタムポートレットを作成する

exteNd Directorで、［ファイル］>［新規］>［ファイル］の順に選択します。

［新規ファイル］ダイアログボックスが表示されます。
［ポートレット]タブを選択して、［ポートレット］を選択し、［OK］をクリックします。

新規ポータルポートレットの作成ウィザードの最初のパネルが表示されます。

次の情報を入力します。

フィールド	指定する内容
クラス名	ポートレットクラスに使用する名前を入力します。
パッケージ	ポートレットのパッケージ名を入力します。パッケージが存在しない場合は、ターゲットリソースのリソースJARのルートに作成されます。パッケージを指定しない場合は、ターゲットリソースセット内のリソースJARのルートにコーポレットクラスが配置されます。
リソースセット	ポートレットフラグメント展開記述子の保存先のリソースセットを選択します。リソースセットによって設計変更の動的展開が提供されます。リソースセットについての詳細は、exteNdDirectorアプリケーションのリソースセットの使用に関する章を参照してください。
Include logging code	このチェックボックスをオンまたはオフにして、ポートレットにロギングコードを追加するかどうか示します。このチェックボックスをオンにすると、ウィザードはコードを自動的に追加し、ロギングレベルがトレースレベルに設定されたときに、メッセージをログに送信できます。
コンテンツタイプ	ポートレットがサポートするコンテンツタイプをオンにします。ポートレットは複数のコンテンツタイプをサポートできます。
データ定義(トランスコードエンジンを使用するポートレットの場合)	ポートレットのデータ定義ファイルを指定します。ポートレットのデータ定義ファイルによって、ポートレットがワイヤレスサポートにデータをトランスコードする方法が決まります。

［次へ］をクリックします。

ウィザードの2番目のパネルが表示されます。

次の情報を入力します。

フィールド	指定する内容
説明	ポートレットに関するテキストの説明を入力します。
表示名	ポートレットの名前を入力します。注記: exteNd Directorポータルではこの表示名は使用されません。
タイトル	ポートレットのタイトルを入力します。このタイトルは、リスト内で、または修飾子でポートレットを表示するために使用されます。
簡単なタイトル	ポートレットの簡単なタイトルを入力します。注記: exteNd Directorポータルでは、この簡単なタイトルは使用されません。
期限切れキャッシュ	ポートレットのキャッシュされたコンテンツ有効期限の後に時間を秒単位で入力します。ポートレットのキャッシュを無効にするには、0を入力します。そのポートレットのキャッシュされたコンテンツが期限切れとならないように指定するには、-1を入力します。
モード	ポートレットがサポートするモードをオンにします。注記: 新しいポートレットは、Java Portlet 1.0に準拠して自動的に［表示］モードをサポートしています。詳細については、ポートレートモードに関する節を参照してください。

［完了］をクリックします。

ポップアップウィンドウが開き、ポートレットウィザードがポートレットの作成をいつ終了したのかが示されます。
［OK］をクリックして、ポップアップウィンドウを閉じます。

このウィザードでは、ポートレットクラスが作成され、Java Portlet 1.0準拠ポートレットの最低要件を満たすJavaソースコードが表示されます。また、動的ローディングをサポートするために必要なファイルも作成されます（ポートレットウィザードによって生成されるものを参照）。
カスタムコードをポートレットに追加します。
ポートレットをコンパイルします。
変更をテストする場合は、次の操作を実行してください

(exteNd Directorを参照)。
1. ポートレットクラスを作成します。
2. ポートレットのJavaソースファイルを表示します。

ポートレットウィザードによって生成されるもの

ポートレットウィザードでは、作成する各ポートレットに対して次の操作が実行されます。

ユーザによる［パッケージ名］への入力に基づいて、ポートレットクラスファイルを作成し、これをユーザが指定したリソースセットに保存します。
ターゲットリソースセットのportal-portletディレクトリにポートレットフラグメント展開記述子を作成します。これはポートレットウィザードで指定した初期設定に基づいてポートレットを説明するXMLファイルです。

記述子ファイルの名前はポートレットクラスの名前と一致します。次に、CreateNewUser.xmlという名前を持つ1つのポートレットフラグメント展開記述子の例を示します。
```
  <portlet xmlns="http://www.novell.com/xml/ns/portlet-fragment" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <description>Creates new user</description>
      <portlet-name>CreateNewUser</portlet-name>
      <display-name>Create New User</display-name>
      <portlet-class>com.novell.portlets.CreateNewUser</portlet-class>
      <expiration-cache>30</expiration-cache>
      <supports>
          <mime-type>text/html</mime-type>
          <portlet-mode>edit</portlet-mode>
      </supports>
      <portlet-info>
          <title>Create New User</title>
          <short-title>Create User</short-title>
      </portlet-info>
      <supported-option>edit</supported-option>
      <auto-register enabled="true"/>
  </portlet>
```
注記: exteNd Directorは、リソースセットに保存されたポートレットクラスとポートレットフラグメント展開記述子を使用して、ユーザが作成中にポートレットに行った変更を動的にロードします。その結果として、変更はサーバのランタイム環境に即時反映されるため、ユーザはアプリケーション全体を再展開せずにテストすることができます。

詳細については、ポートレットの動的ロードのサポートおよびポートレットフラグメント展開記述子に関する節を参照してください。
次のように、ポートレットフラグメント展開記述子の展開でポートレットが自動的に登録されるように設定します。
```
  <auto-register enabled="true"/>
```
ポートレットが自動的に設定されないようにするには、次のように設定を変更します。
```
  <auto-register enabled="false"/>
```

他のソースからのJava Portlet 1.0準拠ポートレットのインポート

exteNd Directorポートレット開発ツールを使用しない場合は、他のソースからポートレットをexteNd Directorのりソースセットにインポートできます。ただし、以下の条件を満たす必要があります。

ポートレットがJava Portlet 1.0に準拠している必要があります。
ポートレットが次を含むJARにパッケージ化される必要があります。
- ポートレットクラスファイル
- 空のportlet.xml展開記述子ファイル
- 各ポートレット定義に対して1つのポートレットフラグメント展開記述子
  
  詳細については、ポートレートフラグメント展開記述子に関する節を参照してください。

Procedure ポートレットをexteNd DirectorポートレットアプリケーションWARにインポートする

前の説明どおりにポートレットをパッケージ化します。
ビューへのリソースのインポートに関する節で説明されている手順に従います。

ポートレット定義の作成

exteNd Directorページフローデザインツールとポートレットウィザードは、ユーザが作成するポートレットクラスのすべてのプロパティを継承する1つのポートレット定義を自動的に作成し、登録します。ただし、ポータル管理者は時には追加定義の作成が必要となることがあります。たとえば、あるポートレットクラスの特徴を全て継承するが、異なる初期化パラメータを使用する定義が必要となることがあります。

その場合は、新しいポートレット記述子を作成することで新しいポートレット定義を作成します。新しいポートレット記述子は新しいポートレットフラグメント展開記述子として、またはportlet.xmlおよびnovell-portlet.xmlの<portlet>セクションとして作成します。ここでは、ここではこの両方のアプローチについて説明します。

Procedure 新しいポートレット定義をポートレットフラグメント展開記述子として作成する

ポートレットクラスに対して作成したポートレットフラグメント展開記述子をコピーすることによって新しいポートレットフラグメント展開記述子を作成します。
<portlet-name>を新しい重複しない名前に変更します。
その他のプロパティを変更し、必要に応じて新しいプロパティを追加します。
<portlet-class>の元のポートレットクラスへの参照は残します。
アプリケーションリソースセットの<portal-portlet>セクション内の記述子ファイルを、<portlet-name>と同じ名前で保存します。
新しいポートレット定義を登録します(ポートレット定義の登録の説明を参照)。

For more information 詳細については、ポートレートフラグメント展開記述子に関する節を参照してください。

Procedure portlet.xmlを変更することで新しいポートレット定義を作成する

Director Designerでアプリケーションが開いている状態で、portlex.xmlを開きます。
対象となるポートレットを説明する<portlet>セクションを見つけます。
元のポートレットの後に新しい<portlet>セクションをコピーして貼り付けます。
新しい<portlet>セクションで、次の操作を実行します。
1. <portlet-name>を新しい重複しない名前に変更します。
2. その他のプロパティを変更し、必要に応じて新しいプロパティを追加します。
<portlet-class>の元のポートレットクラスへの参照は残します。
portlet.xmlを保存します。
新しい定義にexteNd Director追加プロパティを指定する場合は、novell-portlet.xmlを開き、Step 2～Step 3を繰り返します。
novell-portlet.xmlを保存します。
アプリケーションを再構築および再展開します。
新しいポートレット定義を登録します(ポートレット定義の登録の説明を参照)。

ポートレット定義の登録

ポータル管理者は、DAC (Director Administration Console)のポートレット管理セクションを使用してポートレット定義を登録します。登録されたポートレット定義はポートレット登録と呼ばれます。登録時には、管理者はポートレット登録の初期設定と設定を変更できます。ポートレット定義の登録に関する章を参照してください。

ポートレットのテスト

登録プロセスが完了したら、ブラウザで直接実行することでポートレット登録を単位テストできます。

Procedure ブラウザでポートレットを直接実行する

この構文を使用してポートレットパスのURLを入力します。
```
  http://host/context/portal/portlet/ポートレット登録の名前
```
例:

http://localhost/ExpressPortal/portal/portlet/WelcomeMessagePortlet

ポートレットパスURL、およびexteNd Directorポータルによって認識されるその他の要求URLについての詳細は、アプリケーション要求に関する節を参照してください。

ポータルページへのポートレットの追加

ポータルはユニットテストした後で複数のポータルページに追加できます。exteNd Directorでは、コンテナ、共有、およびパーソナルページがサポートされています(ポータルページの操作を参照)。

ユーザはだれでも独自のパーソナルページにポートレットを追加できますが、コンテナページと共有ページにポートレットを追加できるのは認証されているユーザのみです。

For more information ポータルページでのポートレットの使用方法については、次の節を参照してください。