intra-mart 6.1.14

jp.co.intra_mart.foundation.security.account
インタフェース AccountAccessor

既知の実装クラスの一覧:
StandardAccountAccessor

public interface AccountAccessor

アカウントアクセッサインタフェース。

アカウント情報の読み込みおよび書き込みのインタフェースを定義します。

導入されたバージョン:
5.0
バージョン:
1.0

メソッドの概要
 void deleteAccount(String groupId, String userId)
          アカウント情報を削除する。
 void deleteAccountRole(String groupId, String userId, String roleId)
          アカウントロール情報を削除する。
 void deleteAttribute(String groupId, String userId, String name)
          アカウント属性情報を削除する。
 void deleteFavoriteMenu(String groupId, String userId, String menuId)
          マイメニュー情報を削除する。
 Account getAccount(String groupId, String userId)
          アカウント情報を取得する。
 int getAccountCount(String groupId)
          アカウント数を取得する。
 AccountRole getAccountRole(String groupId, String userId, String roleId)
          アカウントロール情報を取得する。
 String[] getAccountRoleIds(String groupId, String userId)
          アカウントロールIDをすべて取得する。
 AccountRole[] getAccountRoles(String groupId, String userId)
          アカウントロール情報をすべて取得する。
 Account[] getAccountsByUserIds(String groupId, String[] userIds)
          指定されたユーザIDのアカウント情報をすべて取得する。
 String getAttribute(String groupId, String userId, String name)
          アカウント属性情報を取得する。
 String[] getAttributeNames(String groupId, String userId)
          アカウント属性情報の名前の一覧を取得する。
 FavoriteMenu getFavoriteMenu(String groupId, String userId, String menuId)
          マイメニュー情報を取得する。
 String[] getFavoriteMenuIds(String groupId, String userId)
          マイメニューIDをすべて取得する。
 FavoriteMenu[] getFavoriteMenus(String groupId, String userId)
          マイメニュー情報をすべて取得する。
 String[] getUserIds(String groupId)
          ユーザIDの一覧を取得する。
 String[] getUserIdsByAccountRole(String groupId, String roleId)
          引数で指定したアカウントロールを持つすべてのアカウントのユーザIDを取得する。
 String[] getUserIdsByAttribute(String groupId, String key, String value)
          アカウント属性情報の値と一致するユーザIDを取得する。
 String[] getUserIdsByRoles(String groupId, String[] roleIds, Date date)
          指定したロールID一覧に有効なアカウントロールが含まれるアカウントのユーザIDを取得します。
 void init(Map params)
          アカウントアクセッサの初期化。
 void insertAccount(String groupId, Account account)
          アカウント情報を新規追加する。
 void insertAccountRole(String groupId, String userId, AccountRole accountRole)
          アカウントロール情報を新規追加する。
 void insertFavoriteMenu(String groupId, String userId, FavoriteMenu favoriteMenu)
          マイメニュー情報を新規追加する。
 Account[] searchAccounts(String groupId, String userId)
          アカウント情報の読み込みます。
 void setAttribute(String groupId, String userId, String name, String value)
          アカウント属性情報を設定する。
 void updateAccount(String groupId, Account account)
          アカウント情報を更新する。
 void updateAccountRole(String groupId, String userId, AccountRole accountRole)
          アカウントロール情報を更新する。
 void updateFavoriteMenu(String groupId, String userId, FavoriteMenu favoriteMenu)
          マイメニュー情報を更新する。
 

メソッドの詳細

deleteAccount

public void deleteAccount(String groupId,
                          String userId)
                   throws AccessSecurityWriteException,
                          NotExistException
アカウント情報を削除する。

パラメータ:
groupId - ログイングループID
userId - 削除するユーザコード
例外:
AccessSecurityWriteException - アカウント情報の削除に失敗した場合スローされます。
NotExistException - 削除するアカウント情報が存在しない場合にスローされます。

deleteAccountRole

public void deleteAccountRole(String groupId,
                              String userId,
                              String roleId)
                       throws AccessSecurityWriteException,
                              NotExistException
アカウントロール情報を削除する。

アカウントに紐付くアカウントロール情報を削除します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
roleId - ロールID
例外:
AccessSecurityWriteException - アカウントロール情報の削除に失敗した場合スローされます。
NotExistException - 削除するアカウントロール情報が存在しない場合にスローされます。

deleteFavoriteMenu

public void deleteFavoriteMenu(String groupId,
                               String userId,
                               String menuId)
                        throws AccessSecurityWriteException,
                               NotExistException
マイメニュー情報を削除する。

アカウントに紐付くマイメニュー情報を削除します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
menuId - メニューID
例外:
AccessSecurityWriteException - マイメニュー情報の削除に失敗した場合スローされます。
NotExistException - 削除するマイメニュー情報が存在しない場合にスローされます。

getAccount

public Account getAccount(String groupId,
                          String userId)
                   throws AccessSecurityReadException
アカウント情報を取得する。

パラメータ:
groupId - ログイングループID
userId - ユーザIDの完全一致名
戻り値:
ユーザアカウントオブジェクト
存在しない場合は、nullを返却します。
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

getAccountsByUserIds

public Account[] getAccountsByUserIds(String groupId,
                                      String[] userIds)
                               throws AccessSecurityReadException
指定されたユーザIDのアカウント情報をすべて取得する。

パラメータ:
groupId - ログイングループID
userIds - ユーザIDの配列
戻り値:
ユーザアカウントオブジェクトの配列
すべて存在しない場合は、空文字列を返却します。
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

getAccountCount

public int getAccountCount(String groupId)
                    throws AccessSecurityReadException
アカウント数を取得する。

パラメータ:
groupId - ログイングループID
戻り値:
ユーザアカウント数
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

getAccountRole

public AccountRole getAccountRole(String groupId,
                                  String userId,
                                  String roleId)
                           throws AccessSecurityReadException
アカウントロール情報を取得する。

アカウントに紐付くアカウントロール情報を取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
roleId - ロールID
戻り値:
ユーザアカウントロール情報
存在しない場合は、nullを返却します。
例外:
AccessSecurityReadException - アカウントロール情報取得に失敗した場合スローされます。

getAccountRoleIds

public String[] getAccountRoleIds(String groupId,
                                  String userId)
                           throws AccessSecurityReadException
アカウントロールIDをすべて取得する。

アカウントに紐付くアカウントロールIDをすべて取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
戻り値:
ユーザアカウントロール情報の配列
存在しない場合は、空の配列を返却します。
例外:
AccessSecurityReadException - アカウントロール情報取得に失敗した場合スローされます。

getAccountRoles

public AccountRole[] getAccountRoles(String groupId,
                                     String userId)
                              throws AccessSecurityReadException
アカウントロール情報をすべて取得する。

アカウントに紐付くアカウントロール情報をすべて取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
戻り値:
ユーザアカウントロール情報の配列
存在しない場合は、空の配列を返却します。
例外:
AccessSecurityReadException - アカウントロール情報取得に失敗した場合スローされます。

getFavoriteMenu

public FavoriteMenu getFavoriteMenu(String groupId,
                                    String userId,
                                    String menuId)
                             throws AccessSecurityReadException
マイメニュー情報を取得する。

アカウントに紐付くマイメニュー情報を取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
menuId - メニューID
戻り値:
マイメニュー情報
存在しない場合は、nullを返却します。
例外:
AccessSecurityReadException - マイメニュー情報取得に失敗した場合スローされます。

getFavoriteMenuIds

public String[] getFavoriteMenuIds(String groupId,
                                   String userId)
                            throws AccessSecurityReadException
マイメニューIDをすべて取得する。

アカウントに紐付くマイメニューIDをすべて取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
戻り値:
マイメニュー情報の配列
存在しない場合は、空の配列を返却します。
例外:
AccessSecurityReadException - マイメニュー情報取得に失敗した場合スローされます。

getFavoriteMenus

public FavoriteMenu[] getFavoriteMenus(String groupId,
                                       String userId)
                                throws AccessSecurityReadException
マイメニュー情報をすべて取得する。

アカウントに紐付くマイメニュー情報をすべて取得します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
戻り値:
マイメニュー情報の配列
存在しない場合は、空の配列を返却します。
例外:
AccessSecurityReadException - マイメニュー情報取得に失敗した場合スローされます。

getUserIds

public String[] getUserIds(String groupId)
                    throws AccessSecurityReadException
ユーザIDの一覧を取得する。

パラメータ:
groupId - ログイングループID
戻り値:
ユーザIDの配列
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

getUserIdsByRoles

public String[] getUserIdsByRoles(String groupId,
                                  String[] roleIds,
                                  Date date)
                           throws AccessSecurityReadException
指定したロールID一覧に有効なアカウントロールが含まれるアカウントのユーザIDを取得します。

パラメータ:
groupId - ログイングループID
roleIds - 検証用ロールIDの一覧
date - 有効期間判定用の日付
戻り値:
有効なアカウントロールを持つアカウントのユーザIDの配列
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

init

public void init(Map params)
アカウントアクセッサの初期化。

このクラスを実装したクラスが生成される時、一度だけこのメソッドが呼び出される。

パラメータ:
params - 初期化パラメータのマップ(Map)

insertAccount

public void insertAccount(String groupId,
                          Account account)
                   throws AccessSecurityWriteException,
                          DuplicateException
アカウント情報を新規追加する。

パラメータ:
groupId - ログイングループID
account - アカウント情報
例外:
AccessSecurityWriteException - アカウント情報の作成に失敗した場合スローされます。
DuplicateException - 追加するアカウント情報が既に存在した場合スローされます。

insertAccountRole

public void insertAccountRole(String groupId,
                              String userId,
                              AccountRole accountRole)
                       throws AccessSecurityWriteException,
                              DuplicateException
アカウントロール情報を新規追加する。

アカウントに紐付くアカウントロール情報を新規に追加します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
accountRole - アカウントロール情報
例外:
AccessSecurityWriteException - アカウントロール情報の作成に失敗した場合スローされます。
DuplicateException - 追加するアカウントロール情報が既に存在した場合スローされます。

insertFavoriteMenu

public void insertFavoriteMenu(String groupId,
                               String userId,
                               FavoriteMenu favoriteMenu)
                        throws AccessSecurityWriteException,
                               DuplicateException
マイメニュー情報を新規追加する。

アカウントに紐付くマイメニュー情報を新規に追加します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
favoriteMenu - マイメニュー情報
例外:
AccessSecurityWriteException - マイメニュー情報の作成に失敗した場合スローされます。
DuplicateException - 追加するマイメニュー情報が既に存在した場合スローされます。

searchAccounts

public Account[] searchAccounts(String groupId,
                                String userId)
                         throws AccessSecurityReadException
アカウント情報の読み込みます。 ユーザIDまたはユーザIDの一部をキーとして検索し、マッチしたアカウント情報を返します。
ただし、以下の文字列を特殊文字列として扱う。
* 0以上の長さの文字列とマッチ
? 1文字の文字列とマッチ

パラメータ:
groupId - ログイングループID
userId - ユーザID(検索キー)
戻り値:
アカウント情報配列
例外:
AccessSecurityReadException - アカウント情報取得に失敗した場合スローされます。

updateAccount

public void updateAccount(String groupId,
                          Account account)
                   throws AccessSecurityWriteException,
                          NotExistException
アカウント情報を更新する。

パラメータ:
groupId - ログイングループID
account - アカウント情報
例外:
AccessSecurityWriteException - アカウント情報の更新に失敗した場合スローされます。
NotExistException - 更新するアカウント情報が存在しない場合にスローされます。

updateAccountRole

public void updateAccountRole(String groupId,
                              String userId,
                              AccountRole accountRole)
                       throws AccessSecurityWriteException,
                              NotExistException
アカウントロール情報を更新する。

アカウントに紐付くアカウントロール情報を更新します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
accountRole - アカウントロール情報
例外:
AccessSecurityWriteException - アカウントロール情報の更新に失敗した場合スローされます。
NotExistException - 更新するアカウントロール情報が存在しない場合にスローされます。

updateFavoriteMenu

public void updateFavoriteMenu(String groupId,
                               String userId,
                               FavoriteMenu favoriteMenu)
                        throws AccessSecurityWriteException,
                               NotExistException
マイメニュー情報を更新する。

アカウントに紐付くマイメニュー情報を更新します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
favoriteMenu - マイメニュー情報
例外:
AccessSecurityWriteException - マイメニュー情報の更新に失敗した場合スローされます。
NotExistException - 更新するマイメニュー情報が存在しない場合にスローされます。

getUserIdsByAccountRole

public String[] getUserIdsByAccountRole(String groupId,
                                        String roleId)
                                 throws AccessSecurityReadException
引数で指定したアカウントロールを持つすべてのアカウントのユーザIDを取得する。 引数で指定したアカウントロールを持つアカウントのユーザIDの一覧を返却します。
指定したアカウントロールの階層のチェックはお行いません。

パラメータ:
groupId - ログイングループID
roleId - String アカウントロールのロールID
戻り値:
ユーザIDの配列(データがない場合は空の配列を返します)
例外:
AccessSecurityReadException - アカウント情報の取得に失敗した場合、または引数が不正な場合にスローされます。

getAttribute

public String getAttribute(String groupId,
                           String userId,
                           String name)
                    throws AccessSecurityReadException
アカウント属性情報を取得する。

パラメータ:
groupId - ログイングループID
userId - ユーザID
name - 属性名
戻り値:
アカウント属性値
存在しない場合は、nullを返却します。
例外:
AccessSecurityReadException - アカウント属性情報の取得に失敗した場合スローされます。

getAttributeNames

public String[] getAttributeNames(String groupId,
                                  String userId)
                           throws AccessSecurityReadException
アカウント属性情報の名前の一覧を取得する。

パラメータ:
groupId - ログイングループID
userId - ユーザID
戻り値:
アカウント属性の名前の一覧
存在しない場合は空の配列を返却します。
例外:
AccessSecurityReadException - アカウント属性情報の取得に失敗した場合スローされます。

getUserIdsByAttribute

public String[] getUserIdsByAttribute(String groupId,
                                      String key,
                                      String value)
                               throws AccessSecurityReadException
アカウント属性情報の値と一致するユーザIDを取得する。

パラメータ:
groupId - ログイングループID
key - 検索対象の属性キー名
value - 検索値
戻り値:
ユーザIDの一覧
存在しない場合は空の配列を返却します。
例外:
AccessSecurityReadException - アカウント属性情報の取得に失敗した場合スローされます。

setAttribute

public void setAttribute(String groupId,
                         String userId,
                         String name,
                         String value)
                  throws AccessSecurityWriteException
アカウント属性情報を設定する。
引数で指定した属性名に一致する属性情報が存在しない場合は、新規登録します。
引数で指定した属性名に一致する属性情報がすでに存在する場合は、指定された属性値で更新します。

パラメータ:
groupId - ログイングループID
userId - ユーザID
name - 属性名
value - 属性値
例外:
AccessSecurityWriteException - アカウント情報の設定に失敗した場合スローされます。

deleteAttribute

public void deleteAttribute(String groupId,
                            String userId,
                            String name)
                     throws AccessSecurityWriteException,
                            NotExistException
アカウント属性情報を削除する。

パラメータ:
groupId - ログイングループID
userId - ユーザID
name - 属性名
例外:
AccessSecurityWriteException - アカウント属性情報の削除に失敗した場合スローされます。
NotExistException - 削除するアカウント情報が存在しない場合にスローされます。

intra-mart 6.1.14

Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.