付録B.1 jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleインターフェイス

<この項の構成>
(1) initialize
(2) login
(3) commit
(4) abort
(5) logout

(1) initialize

機能
DbjAuthModuleインターフェイスの初期化
形式

public void initialize() throws DbjAuthException

機能説明
DbjAuthModuleインターフェイスを初期化します。このメソッドは,DbjFactory0200#getFactoryメソッド実行時に発行されます。
引数
なし。
戻り値

なし。

注意事項
なし。

(2) login

機能
ユーザとパスワードのチェック
形式

public DbjAuthUserInfo login(
    String                        userName,
    String                        passWord,
    ) throws DbjAuthException

機能説明
引数で指定されたログインユーザ名とパスワードが正しいかどうかをチェックします。このメソッドは,DbjSession#loginメソッド実行時に発行されます。
引数
userName(入力)
DbjSession#loginメソッドで指定したユーザ名を指定します。
passWord(入力)
DbjSession#loginメソッドで指定したパスワードを指定します。
戻り値

DbjAuthUserInfoインターフェイス

注意事項
このメソッドは,マルチスレッド環境で発行されます。そのため,スレッドセーフにしておく必要があります。

(3) commit

機能
ユーザ認証,およびユーザ情報の取得後の後処理
形式

public void commit() throws DbjAuthException

機能説明
ユーザ認証,およびユーザ情報の取得後の後処理をします。このメソッドは,DbjSession#loginメソッド実行時に発行されます。
引数
なし。
戻り値

なし。

注意事項
このメソッドは,マルチスレッド環境で発行されます。そのため,スレッドセーフにしておく必要があります。

(4) abort

機能
ユーザ認証でエラーが発生した場合の後処理
形式

public void abort()

機能説明
ユーザ認証でエラーが発生した場合の後処理をします。このメソッドは,DbjAuthExceptionがスローされた場合,ユーザ情報が不正な場合に発行されます。
引数
なし。
戻り値

なし。

注意事項
このメソッドは,マルチスレッド環境で発行されます。そのため,スレッドセーフにしておく必要があります。

(5) logout

機能
UOCセッションハンドルの破棄
形式

public void abort()

機能説明
UOCセッションハンドルを破棄します。このメソッドは,セッション破棄時にセッション内で1回だけ発行されます。このメソッドを発行したあとで,UOCセッションハンドルを使用してメソッドを発行しないでください。
引数
userInfo(入力)
DbjAuthModule#loginメソッドで指定したユーザ名を指定します。
戻り値

なし。

注意事項
このメソッドは,マルチスレッド環境で発行されます。そのため,スレッドセーフにしておく必要があります。