jp.go.nict.langrid.dao.jsonic
クラス JsonicUserDao

java.lang.Object
  jp.go.nict.langrid.dao.jsonic.JsonicUserDao

すべての実装されたインタフェース:

UserDao

public class JsonicUserDao
extends Object
implements UserDao

作成者:

Takao Nakaguchi

コンストラクタの概要

JsonicUserDao(JsonicDaoContext context)

メソッドの概要

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) パスワード変更が必要なユーザを検索する。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

JsonicUserDao

public JsonicUserDao(JsonicDaoContext context)

メソッドの詳細

clear

public void clear()
           throws DaoException

インタフェース UserDao の記述:

ユーザ情報を消去する。

定義:

インタフェース UserDao 内の clear

例外:

DaoException - 処理に失敗した

clearExceptAdmins

public void clearExceptAdmins()
                       throws DaoException

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の clearExceptAdmins

例外:

DaoException - 処理に失敗した

dumpAllUsers

public List<User> dumpAllUsers(String userGridId)
                        throws DaoException

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の dumpAllUsers

パラメータ:

userGridId - ユーザのグリッドID

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

listAllUsers

public List<User> listAllUsers(String userGridId)
                        throws DaoException

インタフェース UserDao の記述:

全ユーザを列挙する。

定義:

インタフェース UserDao 内の listAllUsers

パラメータ:

userGridId - ユーザのグリッドID

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

searchUsers

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

インタフェース UserDao の記述:

ユーザを検索する。

定義:

インタフェース UserDao 内の searchUsers

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

userGridId - ユーザのグリッドID

conditions - 検索条件

orders - ソート順

戻り値:

検索結果

例外:

DaoException - 処理に失敗した

isUserExist

public boolean isUserExist(String userGridId,
                           String userId)
                    throws DaoException

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の isUserExist

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

戻り値:

存在する場合true

例外:

DaoException - 処理に失敗した

addUser

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

インタフェース UserDao の記述:

ユーザを追加する。

定義:

インタフェース UserDao 内の addUser

パラメータ:

user - 追加するユーザ

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

例外:

DaoException - 処理に失敗した

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

deleteUser

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

インタフェース UserDao の記述:

ユーザを削除する。

定義:

インタフェース UserDao 内の deleteUser

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

例外:

DaoException - 処理に失敗した

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

deleteUsersOfGrid

public void deleteUsersOfGrid(String gridId)
                       throws DaoException

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の deleteUsersOfGrid

パラメータ:

gridId - グリッドID

例外:

DaoException - 処理に失敗した

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

getUser

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

インタフェース UserDao の記述:

ユーザを取得する。

定義:

インタフェース UserDao 内の getUser

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザ名

戻り値:

ユーザ

例外:

DaoException - 処理に失敗した

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

hasUserRole

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

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の hasUserRole

パラメータ:

userGridId - ユーザのグリッドID

userId - ユーザID

role - ロール

戻り値:

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

例外:

DaoException - 処理に失敗した

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

searchUsersShouldChangePassword

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

インタフェース UserDao の記述:

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

定義:

インタフェース UserDao 内の searchUsersShouldChangePassword

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

userGridId - ユーザのグリッドID

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

orders - ソート順

戻り値:

検索結果

例外:

DaoException - 処理に失敗した