第23章

ポータル置換文字列

この章では、ポータル置換文字列の参照情報を提供します。この章は、次の節で構成されています。

置換文字列について

exteNd Directorでは、「置換文字列」を使用して、ランタイムのコンテキストベース情報をポータルアプリケーションに含めることができます。置換文字列は、ユーザの現在のテーマまたは現在表示されているポートレットIDなど、ランタイムにダイナミックに変更する事項を参照するキーワードです。これらのキーワードはランタイムに検出されると、現在のHTTP要求か現在のポータルコンテキストあるいはその両方の情報に基づいて、置換されます。

ポータル置換文字列はすべて、com.sssw.portal.util packageのEboPortalUrlHelperクラスで定数として定義されます。

置換文字列を使用する場所

置換文字列は、ポータルアプリケーションの複数の場所で使用できます。

ポータルページ(PIDページおよびJSPページ)
ポータルリソースの記述子
カスタムWebアプリケーションのWAR記述子(web.xml)

ポータルページ

PIDページまたはJSPページでは、置換文字列を使用して、URL、URI、および次のHTML要素のクエリ文字列を構成できます。

アンカータグ(<A>)のHREF属性
イメージタグ(<IMG>)のSRC属性

exteNd Directorは、PortalUrlHelperというポートレットを提供して、ユーザがポータルページで簡単に文字列を置換できる方法を与えます。exteNd Directorは、同じ機能を実行するPortalUrlHelperというカスタムタグも提供します。

For more information カスタムタグ使用の詳細については、PortalUrlHelperを参照してください。

ポータルリソースの記述子

置換文字列は、次のポータルリソースの記述子で使用できます。

リソースタイプ	置換文字列を検索する要素
ポータルレイアウト	preview-image
ポータルテーマ	preview-image thumbnail-image
ポータルオプション	link image
ポートレット	link image option デフォルト

カスタムWebアプリケーションのWAR記述子

置換文字列は、カスタムWebアプリケーションのweb.xmlファイルで次のcontext-param値にも使用できます。

PortalLoginPage
NewUserPage
Portal Home Page
Portal Resource Path

置換文字列のカテゴリ

置換文字列キーワードには、複数のカテゴリがあります。

カテゴリ	キーワード
URL	$context$ $CONTEXT_URL$ $ENCODED_REQUEST_URL$ $PORTAL_URL$ $PORTAL_URL$ $PORTLET_PATH$ $RESOURCE_URL$ $SERVLET_URL$ $THEME_URL$
パス	$COMP_PATH$ $COMPONENT_PATH$ $CONTEXT_PATH$ $PAGE_PATH$ $PAGE_PATH$ $PORTAL_URL$ $PORTLET_PATH$ $REQUEST_URI$ $SERVLET_PATH$ $THEME_PATH$
ID	$COMPONENT_ID$ $COMPONENT_INSTANCE_ID$ $THEME_ID$
その他	$HOST$ $HOST_PORT$ $SCHEME$

$COMP_PATH$

説明

コンポーネントの非修飾コンテンツをサーブするようサーブレットに指示する、コントローラサーブレットへのパスに続く追加のパス情報。

$COMP_PATH$キーワードは、ポータルWARのweb.xmlファイルでcompとして定義されたPortalPathCompKeyコンテキストパラメータと同等です。

例

  $PORTAL_SERVLET_URL$/$COMP_PATH$/HelloWorldComponent

この例は、解析されて次のように変換されます。

  http://host/context/main/comp/HelloWorldComponent

$COMPONENT_ID$

説明

ユーザが現在選択しているポートレットまたはコンポーネントのPortlet Registration IDまたはComponent ID。

例

次の例は、URLhttp://host/context/main/MyPage/financeとHelloWorldという現在のコンポーネントを参照するページのリンクを基にしたものです。

  ?ss_action=remove&ss_comp=$COMPONENT_ID$&ss_instance=$COMPONENT_INSTANCE_ID$

この例は、解析されて次のように変換されます。

  http://host/context/main/MyPage/finance?ss_action=remove&ss_comp=HelloWorld&ss_instance=123456

$COMPONENT_INSTANCE_ID$

説明

ユーザが現在選択しているコンポーネントのインスタンスID。

例

次の例は、URLhttp://host/context/main/MyPage/financeとHelloWorldという現在のコンポーネントを参照するページのリンクを基にしたものです。

  ?ss_action=remove&ss_comp=$COMPONENT_ID$&ss_instance=$COMPONENT_INSTANCE_ID$

この例は、解析されて次のように変換されます。

  http://host/context/main/MyPage/finance?ss_action=remove&ss_comp=HelloWorld&ss_instance=123456

$COMPONENT_PATH$

説明

修飾された単一のコンポーネントをサーブするようサーブレットに指示する、コントローラサーブレットへのパスに続けて追加するパス情報。

$COMPONENT_PATH$キーワードは、ポータルWARのweb.xmlファイルでcomponentとして定義されたPortalPathComponentKeyコンテキストパラメータと同等です。

例

  $PORTAL_URL$/$COMPONENT_PATH$/HelloWorldComponent

この例は、解析されて次のように変換されます。

  http://host/context/main/component/HelloWorldComponent

$context$

説明

exteNd Director 3.0との互換に使用されます。$CONTEXT_URL$は前方置換に使用します。

$context$キーワードは、次のものと同等です。

  $SCHEME$://$HOST_PORT$/$CONTEXT_PATH$

または

  $CONTEXT_URL$

例

  $context$/jsp/PropertySheet.jsp

この例は、解析されて次のように変換されます。

  http://host/context/jsp/PropertySheet.jsp

$CONTEXT_PATH$

説明

HttpServletRequestのコンテキストへのパス。

$CONTEXT_PATH$キーワードは、先行のスラッシュを除いて、HttpServletRequest.getContextPath()から返された値と同等です。

例

  http://host/$CONTEXT_PATH$/

HttpServletRequest.getContextPath()が値Portalを返す場合、この例は解析されて次のように変換されます。

  http://host/Portal/

$CONTEXT_URL$

説明

サーブレットコンテキストのURL参照。

$CONTEXT_URL$キーワードは、次のものと同等です。

  $SCHEME$://$HOST_PORT$/$CONTEXT_PATH$

例

  $CONTEXT_URL$/jsp/PropertySheet.jsp

この例は、解析されて次のように変換されます。

  http://host/context/jsp/PropertySheet.jsp

$ENCODED_REQUEST_URL$

説明

追加パス情報とクエリパラメータを含む、完全にエンコードされたURL参照

$ENCODE_REQUEST_URL$キーワードは、HttpServletRequest.getRequestURL()から返されたURLエンコード値と同等です。

例

  http://host/catalog?callingpage=$ENCODED_REQUEST_URL$

この例は、解析されて次のように変換されます。

  http://host/catalog/callingpage=http%3A%2F%2Flocalhost%2FPortal%2Fmain%2FMyPortal%2FMyProfile

$HOST$

説明

HttpServletRequestのホスト。現在の要求のポート以外のポートを指定する場合に、このキーワードを使用します。

$HOST$キーワードは、現在の要求にHttpServletRequest.getServerName()から返された値と同等です。

例

  $SCHEME$://$HOST$

ホストがmyhostの場合、この例は解析されて次のように変換されます。

  http://myhost

$HOST_PORT$

説明

HttpServletRequestのホストおよびポート。

$HOST_PORT$キーワードは、現在の要求にHttpServletRequest.getServerName()およびHttpServletRequest.getServerPort()から返された値と同等です。

現在のポートが指定されたスキームのデフォルトである場合、ポートは省略されます。

例

  $SCHEME$://$HOSTP_PORT$

現在の要求に対して、HttpServletRequest.getServerName()が返す文字列がmyhostで、HttpServletRequest.getServerPort()が返す文字列が9090の場合、この例は解析されて次のように変換されます。

  http://myhost:9090

$PAGE_PATH$

説明

PIDページをサーブするようサーブレットに指示する、コントローラサーブレットへのパスに続く追加のパス情報。

The $PAGE_PATH$ keyword is equivalent to the PortalPathPagesKey context parameter, defined as pages in the web.xml file for the portal WAR.

例

  $PORTAL_URL$/$PAGE_PATH$/helloWorldPID.html

この例は、解析されて次のように変換されます。

  http://host/context/portal/pages/helloWorldPID.html

$PORTAL_URL$

説明

ベースサーブレット上のポータルへの絶対パス。 PortalPathEntryPointKeyを含みます。PortalPathEntryPointKeyは、全てのポータル要求に対するメインエントリポイントで、Portal Aggregatorはここでリッスンします。このキーは、web.xmlでportalとして定義されています。

$PORTAL_URL$キーワードは、次のものと同等です。

  $CONTEXT_URL$/portal

例

  $PORTAL_URL$/pages/DirectorHome.html

この例は、解析されて次のように変換されます。

  http://host/context/portal/pages/DirectorHome.html

$PORTLET_PATH$

説明

現在の要求におけるポートレットへのパス

$PORTLET_PATH$キーワードは、ベースサーブレット上のポートレットパス情報です。これはPortalPathPortletKeyを含みます。PortalPathPortletKeyは、単一の非修飾ポートレットをサーブするようポータルに指示します。このキーは、web.xmlでportletとして定義されています。

$PORTLET_PATH$は、次のものと同等です。

  $PORTAL_URL$/portlet

例

  $PORTLET_PATH$/Header

この例は、解析されて次のように変換されます。

  http://host/context/portal/portlet/Header

$REQUEST_URI$

説明

現在の要求への絶対URIパス。

$REQUEST_URI$キーワードは、現在の要求でreq.getRequestURI()から返された値と同等です。

例

要求http:/localhost/MyPortal/portal/pg/up_MyPageに対して、$REQUEST_URI$は解析されて次のように変換されます。

/MyPortal/portal/pg/up_MyPage

$REQUEST_URL$

説明

現在の要求への絶対URLパス(クエリパラメータなし)。

$REQUEST_URL$キーワードは、現在の要求でreq.getRequestURL()から返された値と同等です。

例

要求http:/localhost/MyPortal/portal/pg/up_MyPageに対して、$REQUEST_URL$は解析されて次のように変換されます。

  http:/localhost/MyPortal/portal/pg/up_MyPage

$RESOURCE_URL$

説明

リソースパスのURL参照。

$RESOURCE_URL$キーワードは、ポータルWARのweb.xmlファイルで$CONTEXT_URL$/ resourceとして定義されたPortalResourcePathコンテキストパラメータと同等です。

例

  $RESOURCE_URL$/portal-theme/Titanium/images/preview.gif

この例は、解析されて次のように変換されます。

  http://host/context/resource/portal-theme/Titanium/images/preview.gif

$SCHEME$

説明

HttpServletRequestのスキーム。

$SCHEME$キーワードは、現在の要求にHttpServletRequest.getScheme()から返された値と同等です。

例

  $SCHEME$://$HOST$

HttpServletRequest.getScheme()がhttpを返し、ホストがmyhostの場合、この例は解析されて次のように変換されます。

  http://myhost

$SERVLET_PATH$

説明

HttpServletRequestのサーブレットへのパス。

$SERVLET_PATH$キーワードは、先行のスラッシュを除いて、HttpServletRequest.getServletPath()から返された値と同等です。

例

  $CONTEXT_URL$/$SERVLET_PATH$

HttpServletRequest.getServletPath()が/custom.jspを返す場合、この例は解析されて次のように変換されます。

  http://host/context/custom.jsp

$SERVLET_URL$

説明

現在のサーブレットパスのURL参照。

$SERVLET_URL$キーワードは、次のものと同等です。

  $SCHEME$://$HOST_PORT$/$CONTEXT_PATH$/$SERVLET_PATH$

例

  $SERVLET_URL$

この例は、解析されて次のように変換されると考えられます。

  http://host/ExpressPortal/portal/main

$THEME_ID$

説明

ユーザが現在選択しているテーマのテーマID。ログインしているユーザがいない場合、またはユーザが選択されたテーマを持っていない場合は、ポータルのデフォルトテーマが使用されます。

$THEME_ID$キーワードは、ポータルWARのweb.xmlファイルのPortalDefaultThemeコンテキストパラメータと同等です。

例

  $PORTAL_URL$/resource/portal-theme/$THEMEID$/images/edit.gif

現在のテーマがTitaniumの場合、この例は解析されて次のように変換されます。

  http://host/context/main/resource/portal-theme/Titanium/edit.gif

$THEME_PATH$

説明

リソースセット内にある現在のユーザのテーマリソースへの絶対パス。

$THEME_PATH$キーワードは、次のものと同等です。

  $RESOURCE_URL$/portal-theme

例

  $THEME_PATH$/Titanium/images/preview.gif

この例は、解析されて次のように変換されます。

  http://host/context/resource/portal-theme/Titanium/images/preview.gif

$THEME_URL$

説明

テーマのURL参照。

$THEME_URL$キーワードは、次のものと同等です。

  $SCHEME$://$HOST_PORT$/$CONTEXT_PATH$/$RESOURCE_PATH$/portal-theme/$THEME_ID$

$THEME_URL$キーワードは、次のものとも同等です。

  $RESOURCE_URL$/portal-theme/$THEME_ID$

例

  $THEME_URL$/images/edit.gif

解析されて次のように変換されます。

  http://host/context/resource/portal-theme/theme-ID/images/edit.gif