5.6.5 ユーザ編集クラスの作成方法

スマートナビゲーションで使用するユーザ編集クラスの作成方法について説明します。

<この項の構成>
(1) ユーザ編集クラスの種類
(2) ユーザ編集クラスの作成方法
(3) ユーザ編集クラスの格納
(4) ユーザ編集クラスで使用するライブラリ
(5) ユーザ編集クラスのインスタンス生成タイミング

(1) ユーザ編集クラスの種類

スマートナビゲーションでは以下の定義でユーザが作成したクラスを使用することができます。

(2) ユーザ編集クラスの作成方法

ユーザ編集クラスの作成方法を次に示します。

(a) 抽出したデータを正規化するクラス

抽出したデータを正規化するクラスはデータ型定義で使用します。抽出したデータ型を正規化するクラスはjava.text.Formatクラスを継承して作成してください。この場合,String型を引数にとるコンストラクタを必ず作成してください。String型を引数にとるコンストラクタには以下の値を渡します。

(b) メニューの表示制御を行うクラス

メニューの表示制御を行うクラスはWebAPI定義で使用します。メニューの表示制御を行うクラスはuCosminexus Portal Frameworkが提供するMenuPermissionクラスを継承して作成してください。MenuPermissionクラスの詳細は「(4) ユーザ編集クラスで使用するライブラリ」を参照してください。

(c) シナリオ実行時にデータを加工するクラス

シナリオ実行時にデータを加工するクラスはWebAPI定義で使用します。シナリオ実行時にデータを加工するクラスは特にクラスやインタフェースを継承する必要はありませんが,作成するメソッドの引数はString型の配列として,戻り値のデータ型はString型としてください。

また,本クラスはシステムで一度だけインスタンス化されます。複数リクエストから同時にアクセスがあっても問題にないようにスレッドセーフな作りにしてください。

(3) ユーザ編集クラスの格納

作成したユーザ編集クラスはポータルプロジェクトが動作するWebアプリケーションから呼び出し可能な場所に格納してください。例えば,ユーザ編集クラス(user.class)は次の場所に格納します。

{PROJECT_HOME}¥WEB-INF¥classes¥user.class

(4) ユーザ編集クラスで使用するライブラリ

ユーザ編集クラスで使用するクラスライブラリの一覧を次の表に示します。

表5-30 ユーザ編集クラスで使用するクラスライブラリ

クラス名説明
jp.co.hitachi.soft.portal.api.smartnavigation.menu.MenuPermissionメニューの表示制御を行うクラスを作成するためのインタフェースクラスです。

(a) jp.co.hitachi.soft.portal.api.smartnavigation.menu.MenuPermission

機能
スマートナビゲーションメニューの表示制御を行うユーザ編集クラスを作成するためのインタフェースクラスです。

表5-31 メソッドの一覧

戻り値のデータ型メソッド説明
BooleancheckPermission(javax.servlet.http.HttpServletRequest request)ユーザにメニューを表示するか判定します。
メソッドの説明
checkPermission
形式

boolean checkPermission(
        javax.servlet.http.HttpServletRequest request)

機能
ユーザにメニューを表示するか判定します。
パラメタ
request - リクエストオブジェクト
戻り値
ユーザにメニューを表示する場合は,trueを返却します。
例外
なし。

(5) ユーザ編集クラスのインスタンス生成タイミング

ユーザ編集クラスのインスタンスを生成するタイミングを次に示します。