jp.co.hitachi.soft.portal.api.user.PortalUserAccountBean

機能

ポータル利用者自身が,ユーザ情報を登録します。

Beanの項目

宣言

<jsp:useBean id="puab"
class="jp.co.hitachi.soft.portal.api.user.PortalUserAccountBean"
scope="request"/>

対象スコープ

request

メソッドの一覧

戻り値のデータ型メソッド説明
PortalUserAccountgetUserAccount(String userId)ユーザ情報を取得します。
String[]searchUser(String key_colmn, String key_value, String target_colmn)ユーザ情報を検索します。
voidaddUserAccount(PortalUserAccount user, String password)ユーザを新規に登録します。
voidchangeUserAccount(PortalUserAccount user)ユーザ情報を変更します。
voidremoveUserAccount(String userId)ユーザを削除します。
voidchangePassword(String userId, String password)指定したユーザのパスワードを変更します。

メソッドの説明

getUserAccount
形式

public PortalUserAccount getUserAccount(String userId)

機能
ユーザID(userId)に指定したユーザのアカウント情報を取得します。
パラメタ
userId - リポジトリに登録されているユーザID
戻り値
リポジトリにアクセスできるユーザアカウント情報
例外
IllegalArgumentException - 入力パラメタがnullの場合
PortalException - 次の場合に発生します。
  • リポジトリからユーザ情報の取得に失敗した場合
  • 対象のユーザ情報がリポジトリに存在しない場合
searchUser
形式

public String[] searchUser(String key_colmn, String key_value, String target_colmn)

機能
検索対象の項目名(key_colmn),検索値(key_value),および取得対象の項目名(target_colmn)を指定して,ユーザ情報を検索します。なお,検索結果が0件の場合は空の配列が戻り値となります。
パラメタ
key_colmn - 検索対象の項目名
key_value - 検索値(ワイルドカードは指定できない)
target_colmn - 取得対象の項目名
注※
ユーザ情報のマッピング項目を指定してください。なお,検索対象の項目名と取得対象の項目名のどちらかには,ユニークキー(ユーザ情報のマッピング項目の接続先(構成情報)のキーカラム(属性))にマッピングされた項目を指定する必要があります。ユニークキーにマッピングされた項目以外を指定した場合には,取得カラムの指定は無視され,ユニークキーの値が戻り値となります。
戻り値
取得したカラムの値を格納した配列
例外
IllegalArgumentException - 入力パラメタ(key_colmn,target_colmn)がnullの場合
PortalException - データリソース参照中に障害が発生した場合
addUserAccount
形式

public void addUserAccount(PortalUserAccount user, String password)

機能
ユーザアカウント情報(user)およびパスワード(password)に指定したユーザ情報を,マッピング定義で指定したリポジトリに登録します。
パラメタ
user - 追加対象のユーザアカウント情報
password - 追加対象のユーザのパスワード
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullの場合
PortalException - 次の場合に発生します。
  • データリソース参照中に障害が発生した場合
  • すでにユーザ情報が存在する場合
changeUserAccount
形式

public void changeUserAccount(PortalUserAccount user)

機能
リポジトリに登録されているユーザアカウント情報を,ユーザアカウント情報(user)に指定した情報に変更します。
パラメタ
user - 変更対象のユーザアカウント情報
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullの場合
PortalException - 次の場合に発生します。
  • リポジトリへの情報の登録,またはリポジトリからの情報の取得に失敗した場合
  • 対象のユーザ情報がリポジトリに存在しない場合
  • 対象ユーザの所属組織に存在しない組織を指定した場合
removeUserAccount
形式

public void removeUserAccount(String userId)

機能
ユーザID(userId)に指定したユーザのアカウント情報を,リポジトリから削除します。
削除処理は,CosminexusのリポジトリとuCosminexus Portal Frameworkのリポジトリの両方に対して実施されます。uCosminexus Portal Frameworkのリポジトリの削除処理では,指定されたユーザIDに対応するユーザアカウント情報が登録されていない場合もエラーにはならないで,処理を続行されます。
パラメタ
userId - 削除対象のユーザID
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullの場合
PortalException - 次の場合に発生します。
  • リポジトリからの情報の削除に失敗した場合
  • 対象のユーザ情報が,すべてのリポジトリ(CosminexusのリポジトリおよびuCosminexus Portal Frameworkのリポジトリ)に存在しない場合
changePassword
形式

public void changePassword(String userId, String password)

機能
ユーザID(userId)に指定したユーザのパスワードを,パスワード(password)に指定した文字列に変更します。
パラメタ
userId - パスワードを変更するユーザのユーザID
password - 変更後のパスワード
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullまたは対象のユーザ情報がリポジトリに存在しない場合
PortalException - リポジトリの情報の更新に失敗した場合