jp.go.nict.langrid.dao
インタフェース UserDao

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

HibernateUserDao, JsonicUserDao, P2PGridBasisUserDao

public interface UserDao

ユーザ管理を行うDAO。

バージョン:

$Revision:4384 $

作成者:

$Author:nakaguchi $

メソッドの概要

void	addUser(User user, String... userRoles) ユーザを追加する。
void	clear() ユーザ情報を消去する。
void	clearExceptAdmins() ロールが管理者の者を除いてユーザ情報を消去する。
void	deleteUser(String userGridId, String userId) ユーザを削除する。
void	deleteUsersOfGrid(String gridId) 指定されたグリッドのユーザを削除する。
List<User>	dumpAllUsers(String userGridId) 全ユーザを列挙する。
User	getUser(String userGridId, String userId) ユーザを取得する。
boolean	hasUserRole(String userGridId, String userId, String role) ユーザがロールを持っているかどうかを返す。
boolean	isUserExist(String userGridId, String userId) ユーザが存在するかどうかを返す。
List<User>	listAllUsers(String userGridId) 全ユーザを列挙する。
UserSearchResult	searchUsers(int startIndex, int maxCount, String userGridId, MatchingCondition[] conditions, Order[] orders) ユーザを検索する。
UserSearchResult	searchUsersShouldChangePassword(int startIndex, int maxCount, String userGridId, Calendar dateTime, Order[] orders) パスワード変更が必要なユーザを検索する。

メソッドの詳細

clear

void clear()
           throws DaoException

ユーザ情報を消去する。

例外:

DaoException - 処理に失敗した

clearExceptAdmins

void clearExceptAdmins()
                       throws DaoException

ロールが管理者の者を除いてユーザ情報を消去する。

例外:

DaoException - 処理に失敗した

dumpAllUsers

List<User> dumpAllUsers(String userGridId)
                        throws DaoException

全ユーザを列挙する。 データ同期用にvisible=falseのデータも列挙する。

パラメータ:

userGridId - ユーザのグリッドID

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

listAllUsers

List<User> listAllUsers(String userGridId)
                        throws DaoException

全ユーザを列挙する。

パラメータ:

userGridId - ユーザのグリッドID

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

searchUsers

UserSearchResult searchUsers(int startIndex,
                             int maxCount,
                             String userGridId,
                             MatchingCondition[] conditions,
                             Order[] orders)
                             throws DaoException

ユーザを検索する。

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

userGridId - ユーザのグリッドID

conditions - 検索条件

orders - ソート順

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

isUserExist

boolean isUserExist(String userGridId,
                    String userId)
                    throws DaoException

ユーザが存在するかどうかを返す。

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

戻り値:

存在する場合true

例外:

DaoException - 処理に失敗した

addUser

void addUser(User user,
             String... userRoles)
             throws DaoException,
                    UserAlreadyExistsException

ユーザを追加する。

パラメータ:

user - 追加するユーザ

userRoles - ユーザのロール(TomcatでのBASIC認証に使用される)

例外:

DaoException - 処理に失敗した

UserAlreadyExistsException - 指定されたユーザは既に存在する

deleteUser

void deleteUser(String userGridId,
                String userId)
                throws DaoException,
                       UserNotFoundException

ユーザを削除する。

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

例外:

DaoException - 処理に失敗した

UserNotFoundException - 指定されたユーザは存在しない

deleteUsersOfGrid

void deleteUsersOfGrid(String gridId)
                       throws DaoException

指定されたグリッドのユーザを削除する。

パラメータ:

gridId - グリッドID

例外:

DaoException - 処理に失敗した

UserNotFoundException - 指定されたユーザは存在しない

getUser

User getUser(String userGridId,
             String userId)
             throws DaoException,
                    UserNotFoundException

ユーザを取得する。

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

戻り値:

ユーザ

例外:

DaoException - 処理に失敗した

UserNotFoundException - 指定されたユーザは存在しない

hasUserRole

boolean hasUserRole(String userGridId,
                    String userId,
                    String role)
                    throws DaoException

ユーザがロールを持っているかどうかを返す。

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザID

role - ロール

戻り値:

ユーザがロールを持っていればtrue

例外:

DaoException - 処理に失敗した

UserNotFoundException - 指定されたユーザは存在しない

searchUsersShouldChangePassword

UserSearchResult searchUsersShouldChangePassword(int startIndex,
                                                 int maxCount,
                                                 String userGridId,
                                                 Calendar dateTime,
                                                 Order[] orders)
                                                 throws DaoException

パスワード変更が必要なユーザを検索する。

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

userGridId - ユーザのグリッドID

dateTime - この日時以降パスワードを更新していないユーザが対象

orders - ソート順

戻り値:

検索結果

例外:

DaoException - 処理に失敗した