付録B ユーザ作成のアクセスルーチンを使用するためのインターフェースとクラス

ここでは,ユーザ管理システムのアクセスルーチンとしてDocumentBrokerが提供するインターフェースとクラスについて説明します。

ユーザ管理システムのアクセスルーチンは,DocumentBrokerが提供するDbjAuthModuleインターフェースを実装したクラスをユーザが作成し,そのクラス名を文書空間構成定義ファイル(docspace.properties)に指定します。

DocumentBrokerがUOCで提供するインターフェースとクラスの一覧を次の表に示します。

表B-1 DocumentBrokerがUOCで提供するインターフェースとクラス

関数機能
jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleユーザ認証のインターフェースです。
DocumentBrokerのユーザ認証処理時に発行されます。
jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfoユーザ情報の取得インターフェースです。
jp.co.Hitachi.soft.docbroker.auth.DbjAuthExceptionUOC例外クラスです。
UOCでエラーが発生した場合に詳細メッセージを取得します。

各インターフェース,およびクラスに属するメソッドの詳細では,次に示す項目について説明します。

機能
メソッドの概要を記述しています。
形式
メソッドの概要を記述しています。/* */内にコメントを記述しています。
機能説明
メソッドの機能の詳細を記述しています。
引数
引数について次のように記述しています。
引数(入力)
指定する値についての説明
引数(出力)
指定する領域の説明
指定した領域に設定される値の説明
  • 引数は,「形式」で記述した文字列です。
  • (入力)は,ユーザが値を指定することを示しています。
  • (出力)は,ユーザが,DocumentBrokerによって設定される値を格納する領域を指定することを示しています。
戻り値
メソッドを呼び出して,正常な場合に返される値,およびエラーが発生した場合に返される主な値を列挙しています。
注意事項
メソッドを使用する場合の注意事項を記述しています。
<この節の構成>
付録B.1 jp.co.Hitachi.soft.docbroker.auth.DbjAuthModuleインターフェイス
付録B.2 jp.co.Hitachi.soft.docbroker.auth.DbjAuthUserInfoインターフェイス
付録B.3 jp.co.Hitachi.soft.docbroker.auth.DbjAuthExceptionクラス