uCosminexus 電子フォームワークフロー APIリファレンス

[目次][用語][索引][前へ][次へ]

4.1 BLCAuthenticateクラスの概要

<この節の構成>
(1) パッケージ
(2) クラス階層
(3) 形式
(4) 機能
(5) メソッドの概要

(1) パッケージ

jp.co.Hitachi.soft.blc

(2) クラス階層

java.lang.Object
  |
  +--jp.co.Hitachi.soft.blc.BLCAuthenticate

(3) 形式

public class BLCAuthenticate
extends java.lang.Object

(4) 機能

このクラスは,BLC認証によるユーザ情報管理で使用するメソッドを提供するクラスです。

BLCシステムを使用するためには,認証メソッド(loginメソッド)を呼び出す必要があります。また,認証後のページ間の遷移では,それぞれのJSPページでログインチェックをするメソッド(checkLoginStatusメソッド)を呼び出す必要があります。

管理するユーザ情報の基本項目を次に示します。なお,情報はBLCDictionaryクラスオブジェクトで保持されます。

表4-1 ユーザ情報の基本項目

キー名 意味 オブジェクト種別
blc_us_id ユーザID String
blc_us_no 従業員番号 String
blc_us_nmlastj 氏名漢字名字 String
blc_us_nmfirstj 氏名漢字名前 String
blc_us_nmlastk 氏名カナ名字 String
blc_us_nmfirstk 氏名カナ名前 String
blc_us_nmlaste 氏名英字名字 String
blc_us_nmfirste 氏名英字名前 String
blc_us_cdbelong 所属する組織コード String
blc_us_nmbelong 所属する組織略称 String
blc_us_cdjobt 役職コード String
blc_us_nmjobt 役職名 String
blc_us_abjobt 役職略称 String
blc_us_mailaddr メール(e-Mail) String
blc_us_telout TEL 外線 String
blc_us_telext TEL 内線 String
blc_us_nmfull 氏名漢字 String
留意事項
メソッドにパラメータとして指定できるユーザIDは,半角英数字だけです。
日本語などの2バイトコードや記号を含む文字列をユーザIDに指定してメソッドを呼び出した場合,動作は保証されません。

(5) メソッドの概要

戻り値のデータ型 形式 機能
void checkLoginStatus() BLC認証されているかどうかを,httpリクエストからCookieを取得してチェックします。
java.lang.String getAuthenticateUserId() BLC認証したユーザのユーザIDを取得します。
BLCDictionary getAuthenticateUserInfo() BLC認証したユーザのユーザ情報を,BLCDictionaryクラスオブジェクトで取得します。
java.lang.String getUserId() BLC認証したユーザの実行ユーザIDを取得します。
BLCDictionary getUserInfo() BLC実行ユーザのユーザ情報をBLCDictionaryクラスオブジェクトで取得します。
void login(java.lang.String userId) BLCログイン認証ユーザIDを指定して,BLC認証をします。
void logout() BLCログアウトをします。
void resetUserId() BLC認証したユーザの実行ユーザIDと実行ユーザ情報を無効にします。
void setUserId(java.lang.String userId) BLCログイン認証ユーザの実行ユーザを変更します。
void setUserInfo(BLCDictionary userInfo) BLC実行ユーザのユーザ情報を設定します。
クラスjava.lang.Objectから継承したメソッド
equals,getClass,hashCode,notify,notifyAll,toString,wait,wait,wait