6.6.4 変数を設定する

取得するコンテンツを指定するときに設定する変数を設定します。変数を使用することでポートレット表示時の動作を動的に変更できます。

[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)で,変数名と変数への値の代入方法を指定することで,変数を設定します。設定した変数は,「6.6.4(3) 変数を使用する」に示す個所で使用することができます。[ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)の詳細は,「10.3.5(3) 変数設定コンポーネントパラメタ設定画面」を参照してください。

Webコンテンツポートレットで使用する変数には次の3種類があります。

変数に値を代入する方法は次の2種類があります。

<この項の構成>
(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) 変数を設定する

  1. メニュー領域から[変数設定]を選択します。
    [ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)が表示されます。
    [ポートレット編集]画面(変数設定コンポーネントパラメタ設定画面)の詳細は,「10.3.5(3) 変数設定コンポーネントパラメタ設定画面」を参照してください。
  2. 情報を入力します。
  3. [保存]ボタンをクリックします。
    設定した内容が一時保存されます。この情報を登録する場合は,[完了]ボタンをクリックしてください。

(3) 変数を使用する

変数は次の形式により指定し使用します。変数を指定した部分が変数の値に置き換わります。

$[変数名]

変数は以下の場所で使用することができます。

画面名項目名
Webアクセスコンポーネントパラメタ設定画面Form認証用URL
Form認証用URLでコンテンツを取得する
コンテンツ取得用URL
ログアウトURL
Basic認証対応の有無
proxyホスト
proxyポート
proxyユーザ
proxyパスワード
Form認証レルム
Form認証失敗とみなす文字
Form認証情報
ユーザIDのフィールド名
パスワードのフィールド名
表示名
認証ページフィールド名
固定値
パスワードを適用する
Cookieドメイン
キー
ドメイン名
パス
Secure属性
変数設定コンポーネントパラメタ設定画面メソッド引数
テンプレート適用コンポーネントパラメタ設定画面リンク先ターゲット

注※ 特定変数で指定します。


また,テンプレート適用コンポーネントパラメタ設定画面でインポートするテンプレート内で次の形式で使用することができます。

$変数名