uCosminexus Portal Framework 運用管理者ガイド
取得するコンテンツを指定するときに設定する変数を設定します。変数を使用することでポートレット表示時の動作を動的に変更できます。
[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)で,変数名と変数への値の代入方法を指定することで,変数を設定します。設定した変数は,「6.6.4(3) 変数を使用する」に示す個所で使用することができます。[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)の詳細は,「10.3.5(3) 変数設定コンポーネントパラメタ設定画面」を参照してください。
Webコンテンツポートレットで使用する変数には次の3種類があります。
- ユーザ定義変数
Webコンテンツポートレットを作成する運用管理者が定義する変数です。運用管理者が任意の変数名で設定することができます。
- 特定変数
uCosminexus Portal Frameworkで定義済みの変数です。この変数は,[ポートレット編集]画面(Webコンテンツアクセスコンポーネントパラメタ設定画面など)の設定をポートレット表示時に動的に変更する場合に使用します。この変数に値を設定することで,[ポートレット編集]画面(Webコンテンツアクセスコンポーネントパラメタ設定画面など)での設定に関係なく,ポートレット表示時の動作を変更することができます。
特定変数を次に示します。それぞれの特定変数が[ポートレット編集]画面(Webコンテンツアクセスコンポーネントパラメタ設定画面など)の各設定項目に対応しています。
- {コンポーネントID※1}_FormAuthURLContents
アクセスサイトの「Form認証用URLでコンテンツを取得する」項目の状態を設定します。
"true"に設定した場合:チェックを付けた状態
"false"に設定した場合:チェックを外した状態
- {コンポーネントID※1}_BasicAuthRadio
アクセスサイトの「Basic認証対応の有無」項目の状態を設定します。
"0"に設定した場合:無効
"1"に設定した場合:有効
- {コンポーネントID※1}_FormAuthRadio
「Form認証情報」項目の状態を設定します。
"0"に設定した場合:ポータルと同じ
"1"に設定した場合:ユーザが入力
- {コンポーネントID※1}_httpsProxyUser
SSL通信時のProxyユーザを設定します。
- {コンポーネントID※1}_httpsProxyPassword
SSL通信時のProxyパスワードを設定します。
- {コンポーネントID※1}_FormFieldName_{フィールド番号※2}
アクセスサイトの「表示名」項目を設定します。
表示名には次のストリングリソースキー名を指定します。
表示名 ストリングリソースキー名 ユーザ名 CMP_PORTLET_AUTH_FIELD_1 ユーザID CMP_PORTLET_AUTH_FIELD_2 パスワード CMP_PORTLET_AUTH_FIELD_3 ニックネーム CMP_PORTLET_AUTH_FIELD_4 ログインID CMP_PORTLET_AUTH_FIELD_5 ドメイン CMP_PORTLET_AUTH_FIELD_6 組織 CMP_PORTLET_AUTH_FIELD_7 グループ CMP_PORTLET_AUTH_FIELD_8 フィールド1 CMP_PORTLET_AUTH_FIELD_9 フィールド2 CMP_PORTLET_AUTH_FIELD_10 フィールド3 CMP_PORTLET_AUTH_FIELD_11 フィールド4 CMP_PORTLET_AUTH_FIELD_12 フィールド5 CMP_PORTLET_AUTH_FIELD_13 フィールド6 CMP_PORTLET_AUTH_FIELD_14 フィールド7 CMP_PORTLET_AUTH_FIELD_15 フィールド8 CMP_PORTLET_AUTH_FIELD_16 フィールド9 CMP_PORTLET_AUTH_FIELD_17 フィールド10 CMP_PORTLET_AUTH_FIELD_18 フィールド11 CMP_PORTLET_AUTH_FIELD_19 フィールド12 CMP_PORTLET_AUTH_FIELD_20 フィールド13 CMP_PORTLET_AUTH_FIELD_21 フィールド14 CMP_PORTLET_AUTH_FIELD_22 フィールド15 CMP_PORTLET_AUTH_FIELD_23 フィールド16 CMP_PORTLET_AUTH_FIELD_24 固定値 FORM_AUTH_HIDDEN_ITEM 使用しない なし(空文字列を指定します) - {コンポーネントID※1}_FormFieldUsePassword_{フィールド番号※2}
アクセスサイトの「パスワード属性を適用する」項目の状態を設定します。
"true"に設定した場合:パスワード属性を適用する
"false"に設定した場合:パスワード属性を適用しない
- {コンポーネントID※1}_sendCookieSecureRadio_{フィールド番号※3}
アクセスサイトの「Secure属性」項目の状態を設定します。
"0"に設定した場合:無効
"1"に設定した場合:有効
注※1 コンポーネントIDには,アクセスサイト1〜10に対応するaccess1〜access10を指定します。アクセスサイト1の場合は「access1」です。
注※2 フィールド番号には,[ポートレット編集]画面(Webコンテンツアクセスコンポーネントパラメタ設定画面)のForm認証フィールド1〜16に対応する0〜15を指定します。Form認証フィールド1の場合は0です。
注※3 フィールド番号には,[ポートレット編集]画面(Webコンテンツアクセスコンポーネントパラメタ設定画面)のアクセスサイトに送信するCookie1〜3に対応する0〜2を指定します。アクセスサイトに送信するCookie1の場合は0です。
- 予約変数
uCosminexus Portal Frameworkで定義済みの変数です。この変数にはuCosminexus Portal Frameworkが代入した値が格納されています。この変数は[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)で変数の設定をしなくても,「6.6.4(3) 変数を使用する」に示す個所で使用することができます。
予約変数を次に示します。
- hptl_com_ID
uCosminexus Portal FrameworkにログインしたときのユーザIDです。
- hptl_com_PW
uCosminexus Portal Frameworkにログインしたときのパスワードです。
変数に値を代入する方法は次の2種類があります。
- ユーザ編集クラスを使用する
ユーザが作成したクラスを呼び出し,変数に値を代入する方法です。ユーザ属性やリクエストの情報を変数に代入するプログラムを作成することができます。[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)でユーザ編集クラスを指定することで変数に値を代入することができます。
- Form認証フィールドを使用する
アクセスサイトのForm認証フィールドの値を参照する方法です。アクセスサイトにForm認証するときにユーザが入力した情報(ユーザIDやパスワード)を変数に代入することができます。[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)でForm認証フィールドを指定することで変数に値を代入することができます。
- <この項の構成>
- (1) ユーザ編集クラスを作成する
- (2) 変数を設定する
- (3) 変数を使用する
(1) ユーザ編集クラスを作成する
ユーザ編集クラスは以下の抽象クラスを継承して作成し,変数の値を取得するためのメソッドを追加します。変数の値を取得するためのメソッドの引数はString型の配列とし,返却値はString型としてください。
- [抽象クラス]
jp.co.hitachi.soft.portal.portal.portlets.component.UserCustomizeVariant
- [フィールド変数]
HttpServletRequest USER_CUSTMIZE_REQUEST- HTTPサーブレットリクエストオブジェクトを格納します。
- [抽象メソッド]
void setRequest(HttpServletRequest request)- HTTPサーブレットリクエストオブジェクトを設定します。
- [具象メソッド]
void setVariant(String name,String value)- 「変数設定」の変数を設定します。ここで設定した変数は変数設定コンポーネントパラメタ設定画面で定義した変数と同じ役割を持ちます。メソッド引数nameに変数名,メソッド引数valueに値を指定します。すでに同名の変数が設定されている場合は,メソッド引数valueの値で上書きします。
- [ユーザ編集クラス作成例]
package com.test.UOC; import javax.servlet.http.HttpServletRequest; import jp.co.hitachi.soft.portal.api.user.PortalUserInfoBean; import jp.co.hitachi.soft.portal.portal.portlets.component.UserCustomizeVariant; public class sampleUOC extends UserCustomizeVariant { public void setRequest(HttpServletRequest request) { //フィールド変数に値を設定する USER_CUSTMIZE_REQUEST = request; } public String testMethod(String[] arg0) { //メソッド引数に"_test"を付けて返却する return arg0[0]+"_test"; } public String testMethod2() throws Exception{ //ユーザの属性TELの値を返却する PortalUserInfoBean puib = new PortalUserInfoBean(USER_CUSTMIZE_REQUEST); String ret = (String)puib.getParameter("TEL"); return ret; } }
- [ユーザ編集クラス格納先]
- 作成したユーザ編集クラスは,ポータルプロジェクトが動作するWebアプリケーションから呼び出し可能な場所に格納してください。
- 例えば,ユーザ編集クラス(sampleUOC.class)は次の場所に格納します。
{PROJECT_HOME}\WEB-INF\classes\com\test\UOC\sampleUOC.class- なお,ポータルプロジェクトおよび{PROJECT_HOME}については,マニュアル「uCosminexus Portal Framework システム管理者ガイド」を参照してください。
(2) 変数を設定する
- メニュー領域から[変数設定]を選択します。
[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)が表示されます。
[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)の詳細は,「10.3.5(3) 変数設定コンポーネントパラメタ設定画面」を参照してください。
- 情報を入力します。
- [保存]ボタンをクリックします。
設定した内容が一時保存されます。この情報を登録する場合は,[完了]ボタンをクリックしてください。
(3) 変数を使用する
変数は次の形式により指定し使用します。変数を指定した部分が変数の値に置き換わります。
$[変数名]変数は以下の場所で使用することができます。
画面名 項目名 Webアクセスコンポーネントパラメタ設定画面 Form認証用URL Form認証用URLでコンテンツを取得する※ コンテンツ取得用URL ログアウトURL Basic認証対応の有無※ proxyホスト proxyポート proxyユーザ proxyパスワード Form認証レルム Form認証失敗とみなす文字 Form認証情報※ ユーザIDのフィールド名 パスワードのフィールド名 表示名※ 認証ページフィールド名 固定値 パスワードを適用する※ Cookieドメイン キー ドメイン名 パス Secure属性※ 変数設定コンポーネントパラメタ設定画面 メソッド引数 テンプレート適用コンポーネントパラメタ設定画面 リンク先ターゲット 注※ 特定変数で指定します。
また,テンプレート適用コンポーネントパラメタ設定画面でインポートするテンプレート内で次の形式で使用することができます。
$変数名
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi INS Software, Ltd.