2 Oracle WebCenter WSRP Producer for .NET構成ファイルの理解

この章では、Oracle WebCenter WSRP Producer for .NET構成ファイル(wsrp-producer.xml)の内容について説明します。

Webパーツまたは.NETアプリケーションをWSRPポートレットとして設定することは、wsrp-producer.xml構成ファイルが適切に作成されるまで完了しません。このファイルについて理解することが重要です。

<installdir>\wsrpdefaultにインストールされているwsrp-producer.xmlファイルを開いて参照します。

第2.1項「ポートレット・ノード」
第2.2項「ポートレット・コンテンツ変換ルールセット」

2.1 ポートレット・ノード

ポートレットとして公開する各Webパーツまたは各.NET Webアプリケーションは、専用の<portlet>ノードを持つ必要があります。ポートレットには、次の要素を含めることができます。

ポートレット・ハンドル: <handle>は、ポートレットを一意に特定する文字列である必要があります。このポートレット・プロパティには英数字をお薦めします。
サポートされているロケール: <supported-locale>は、サポートされているロケールのカンマ区切りリストである必要があります。通常のフォーマットは[2 char language code] "-" [2 char country code] (en-USなど)です。この情報は、登録時にWSRPコンシューマ・ポータルに送信されます。これらの値は、タイトルや説明など、ポートレットのコア・プロパティのローカリゼーションも行います。
ローカライズされたポートレット情報: <description>、<display-name>、<title>および<short-title>プロパティは、指定された"lang"属性値に従ってローカライズされます。各値は、description、displayName、titleおよびshortTitleという対応するWSRP値のLocalizedStringとして返されます。これらのプロパティの詳細は、WSRPの仕様のPortletDescriptionタイプを参照してください。

サポートされているモード: <supports>要素は、いくつかのサブ要素を含んでいます。

ポートレット・モード: <portlet-modes>要素は、関連するWSRPポートレット・モードのURL (通常は相対パス)を定義します。Oracle WebCenter WSRP Producer for .NETは、次のようにポートレット・モードを処理します。

表2-1 ポートレット・モード

ポートレット・モード	アクション
wsrp:view	ポートレットを表示します。
wsrp:edit	ポートレット・エディタを表示します。
wsrp:help	ヘルプ用のWebページを表示します。
wsrp:preview	このモードは、wsrp:viewと同様に処理されます。
urn:javax:portlet:mode:custom:edit_defaults	このWSRPカスタム・モードは、Oracle WebCenter Portalのカスタマイズ用です。

このリストに載っていないモードは、wsrp:viewモードのように処理されます。各ポートレット・モードの例は、次に続く項を参照してください。

MIMEタイプ: <mime-type>要素は、ポートレットによってサポートされているMIMEタイプを定義します。すべてのMIMEタイプがサポートされている場合は、"*"を渡します。この設定の詳細は、WSRPの仕様のMarkupTypeタイプを参照してください。

ユーザー・プロファイル情報: <user-profile>要素を使用すると、ポートレットで使用する<profile-item>要素にユーザー・プロファイル情報を定義できます。この要素の使用方法に関する詳細は、第5.8項「ユーザー・プロファイル・データの追加」を参照してください。

ポートレット・コンテンツ変換: <RuleSetRef>セクションを使用すると、既存の変換ルール(ポートレット・ノードの外部で定義されます)とポートレットを関連付けることができます。関連付けられた<RuleSet>要素で定義されたIDを使用します。カンマ区切り文字列中に適切な順序でIDを配置することで、複数のルールセットを参照できます。独自の変換ルールを追加するには、<RewriterConfig>要素を追加し、<Rules>要素に定義されている同じ構造に従います。次の例に示すとおり、既存のルールはカスタム・ルールと組み合せることができます。

<RuleSetRef>Default</RuleSetRef>
<RewriterConfig>
  <Rules>
    <RewriterRule>
      <LookFor>test.csv</LookFor>
      <ChangeTo>download.csv</ChangeTo>
      <ChangeToAbsolute>false</ChangeToAbsolute>
      <ApplyTo>*</ApplyTo>
      <MakeResource>false</MakeResource>
    </RewriterRule>
  </Rules>
</RewriterConfig >

注意:

カスタム・ルールが既存のルールセットと組み合せられている場合、カスタム・ルールは、すべての参照ルールセットの後にリストの順序で適用されます。

前述の例ではポートレットは、デフォルトのルールセットに関連付けられたすべてのルールを適用し、「test.csv」を「download.csv」で置き換えます。

ルールセットの詳細は、次の項を参照してください。

2.2 ポートレット・コンテンツ変換ルールセット

Oracle WebCenter WSRP Producer for .NETでは正規表現を使用して、相対URLを絶対URLに、また、必要に応じてWSRPコンシューマを通してプロキシ処理されたURLに変換します。特定の変換ルールは、<RuleSet>要素にあるwsrp-producer.xmlファイル内で定義され、各ポートレット内で参照されます。ルールセットは、マークアップ変換ルールのグループをまとめるための方法です。

デフォルトでは、hrefを変換し、WSRPリソースとしてプロキシ設定する単一のデフォルト・ルールセットがあり、"src" URL参照(イメージおよびJavaScript)は変換されますが、プロキシ設定は行われません。様々な変換設定を使用するには、次に説明するとおり、新しいルールセットを作成します。ポートレット内でのルールセットの使用例の詳細は、第5.5項「マークアップ変換の使用方法」を参照してください。

注意:

デフォルト・ルールセットを変更しないことを強くお薦めします。

2.2.1 カスタム・ルールの作成

前の項で説明したとおり、カスタム・ルールは、<RuleSet>要素内のポートレット・ノードの内側または外側で定義できます。同じルールを使用する必要がある一連のポートレットがある場合、ルールセットは非常に有用になります。ポートレットごとにURL変換ルールをコピーするかわりに、単一のルールセットを作成し、各ポートレットのIDを参照できます。<RewriterConfig>要素の構文ルールは、両方の場所で同じです。(ルールが個別のポートレット・ノードの内側で定義されている場合、<RuleSet>要素は省略されます。)

<RewriterConfig>要素は、次の表の要素を使用して変換ルールを定義する<RewriterRule>要素を含んでいる<Rules>要素を含んでいます。

表2-2 変換ルールの要素

要素	値/説明
`<LookFor>`	必須。テキストまたは正規表現、あるいはその両方を使用して、検索するURLを定義します。たとえば、`<LookFor>(activeSrc\":\")([^\"]+)</LookFor>`は、トランスフォーマが、置換のために"activeSrc":"./test/foo/bar.js"や"activeSrc":"test2/bas.html"のようなURLを探すことを示しています。 `<LookFor>`は、`<RewriterRule>`要素の中で1番目の要素にする必要があります。
`<ChangeToAbsolute>`	必須。trueに設定されている場合は、`<LookFor>`要素で識別された任意のURLを絶対URLに変換します。(WSRPコンシューマを通してプロキシ処理したときに相対URLは意味をなさないため、通常、URLに対して実行する変換は、URLを絶対URLにします。)
`<MakeResource>`	必須。trueに設定されている場合は、URLはWSRPコンシューマによってプロキシ処理されます。保護するリソースにとってこれが重要である一方、WSRPコンシューマはURLを書き換える必要があり、ブラウザ・キャッシングを使用することができないため、このオプションを大量に適用すると、パフォーマンスに大きな悪影響を及ぼすことがあります。プロキシ処理をするURLのみを含めるようにするには、`<ApplyTo>`を使用します。
`<ApplyTo>`	キーワードのカンマ区切りリストを使用して、変換されてプロキシ処理されるURLを限定します。(`<ChangeToAbsolute>`がルールに含まれている場合、`<LookFor>`要素によって返されるすべてのURLは絶対URLに変換されます。)
`<ChangeTo>`	`<LookFor>`要素によって返されるテキストを、用意されているテキストに変更します。(これはURL変換には使用されませんが、`<RewriterRule>`要素を使用してポートレット内の任意のテキストを変更でき、また、正規表現を含めることができます。)たとえば、次のエントリは、myhostからのトラフィックをmyhost.mycompany.comにリダイレクトします。 <RewriterRule> <LookFor>myhost[\:][0-9] </LookFor> <ChangeTo>myhost.mycompany.com</ChangeTo> </RewriterRule>