4.6.6 loginログイン

<この項の構成>
(1) 機能
(2) 形式
(3) 引数
(4) 戻り値
(5) 例外

(1) 機能

文書空間にログインしてセッションを確立し,同時にユーザ識別子およびパスワードの認証を実行して,文書空間インターフェース(DbjDocSpaceインターフェース)を取得します。このメソッドは,一つの文書空間にアクセスするほかのメソッドの実行前に実行する必要があります。確立しているセッションの有効期限は,DbjSession#logoutメソッドを実行するまで,または文書空間への接続をタイムアウト(DocumentBrokerサーバで設定される)するまでです。なお,ユーザ認証の失敗,および二重のログインがあった場合は,例外がスローされます。

(2) 形式

DbjDocSpace login(
   String       userName,
   String       passWord
)

(3) 引数

userName(入力)
ログインするユーザのユーザ識別子を指定します。
passWord(入力)
ログインするユーザのパスワードを指定します。

(4) 戻り値

文書空間オブジェクトアクセスインターフェース(DbjDocSpaceインターフェース)

(5) 例外

DbjCORBAException
CORBAエラーの場合
DbjDBException
DBエラーの場合
DbjException
Java クラスライブラリ固有のエラーの場合
DbjIllegalDocSpaceIdException
接続先の文書空間識別子が不正の場合
DbjNotAuthenticatedException
認証エラーの場合
DbjSessionOverflowException
セッション数が同時に接続できる数を超えた場合
IllegalStateException
すでにログインしていた場合