jp.co.hitachi.soft.portal.api.user.LoginActionBean

機能

ログインまたはログアウト処理をするBeanです。

Beanの項目

宣言

<jsp:useBean id="user"
class="jp.co.hitachi.soft.portal.api.user.PortalLoginActionBean"
scope="session" />

対象スコープ
session

メソッドの一覧

戻り値のデータ型メソッド説明
voiddoAfterLogin(HttpServletRequest req, HttpServletResponse res, Exception e)ログイン用jspによる処理が終わったことをuCosminexus Portal Frameworkに知らせます。ログイン用jspでログイン処理する場合,このメソッドを必ず呼び出してください。
CallbackHandlergetCallbackHandler()Beanに結び付くCallbackHandlerを返却します。
LoginContextgetLoginContext()ログインモジュールを切り替えてログイン認証するログインコンテキストを取得します。
HttpServletRequestgetRequest()setRequest()メソッドで設定されたHttpServletRequestオブジェクトを返却します。
HttpServletResponsegetResponse()setResponse()メソッドで設定されたHttpServletResponseオブジェクトを返却します。
SubjectgetSubject()ログインコンテキストに関連づけられたサブジェクトを返却します。
voidlogin()getLoginContext()メソッドで取得されるログインコンテキストに対して認証処理をします。
voidlogout()ログアウト処理をします。
voidmakeUser()getSubject()メソッドで取得したサブジェクトからログインユーザ情報をsessionに登録します。
voidsetCallbackHandler(CallbackHandler cbh)getCallbackHandler()メソッドで戻されるCallbackHandlerを設定します。
voidsetLoginContext(LoginContext lc)getLoginContext()メソッドで戻されるログインコンテキストを設定します。
voidsetRequest(HttpServletRequest request)getRequest()メソッドで戻されるHttpServletRequestメソッドを設定します。
voidsetResponse(HttpServletResponse response)getResponse()メソッドで戻されるHttpServletResponseメソッドを設定します。

メソッドの説明

doAfterLogin
形式

public void doAfterLogin(HttpServletRequest req,
                       HttpServletResponse res,
                       Exception e)

機能
ログイン用jspによる処理が終わったことをuCosminexus Portal Frameworkに知らせます。ログイン用jspでログイン処理する場合,このメソッドを必ず呼び出してください。このメソッドが呼び出されなかった場合,正しくログインできません。
パラメタ
req - HTTPリクエストオブジェクト
res - HTTPレスポンスオブジェクト
e - uCosminexus Portal Frameworkに通知する例外
戻り値
なし
例外
Exception
getCallbackHandler
形式

public CallbackHandler getCallbackHandler()

機能
このBeanに結び付くコールバックハンドラを返却します。
通常はCosminexus統合ユーザ管理フレームワークが作成するコールバックハンドラを返却します。setCallbackHandler()メソッドを用いてユーザ独自のコールバックハンドラを作成することもできます。setCallbackHandler()メソッドについては,「setCallbackHandler」を参照してください。
パラメタ
なし
戻り値
コールバックハンドラ
例外
DataBackendException - リポジトリ接続エラーが発生した場合
getLoginContext
形式

public LoginContext getLoginContext()

機能
ログインモジュールを切り替えてログイン認証するログインコンテキストを取得します。ただし,setLoginContext()メソッドで設定されている場合はそれを返却します。
パラメタ
なし
戻り値
認証するログインコンテキスト
例外
DataBackendException - リポジトリ接続エラーが発生した場合
getRequest
形式

public HttpServletRequest getRequest()

機能
setRequest()メソッドで設定されたHttpServletRequestオブジェクトを返却します。設定されていない場合はnullを返却します。
パラメタ
なし
戻り値
リクエストオブジェクト
例外
なし
getResponse
形式

public HttpServletResponse getResponse()

機能
setResponse()メソッドで設定されたHttpServletResponseオブジェクトを返却します。設定されていない場合はnullを返却します。
パラメタ
なし
戻り値
レスポンスオブジェクト
例外
なし
getSubject
形式

public Subject getSubject()

機能
LoginContextに関連づけられたサブジェクトを返却します。
パラメタ
なし
戻り値
認証したサブジェクト
例外
なし
login
形式

public void login()

機能
getLoginContext()メソッドで取得されるログインコンテキストに対して認証処理をします。
パラメタ
なし
戻り値
なし
例外
PasswordMismatchException - パスワード入力の失敗回数が規定回数を超えた場合
DataBackendException - リポジトリ接続エラーが発生した場合
logout
形式

public void logout()

機能
ログアウト処理をします。
パラメタ
なし
戻り値
なし
例外
DataBackendException - リポジトリ接続エラーが発生した場合
UnKnownEntityException
makeUser
形式

public void makeUser()

機能
getSubject()メソッドで取得したサブジェクトからログインユーザ情報をsessionに登録します。
パラメタ
なし
戻り値
なし
例外
DataBackendException - リポジトリ接続エラーが発生した場合
setCallbackHandler
形式

public void setCallbackHandler(CallbackHandler cbh)

機能
getCallbackHandler()メソッドで戻されるCallbackHandlerを設定します。
パラメタ
cbh - コールバックハンドラ
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合
setLoginContext
形式

public void setLoginContext(LoginContext lc)

機能
getLoginContext()メソッドで戻されるログインコンテキストを設定します。
パラメタ
lc - 認証するログインコンテキスト
戻り値
なし
例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合
setRequest
形式

public void setRequest(HttpServletRequest request)

機能
getRequest()メソッドで戻されるHttpServletRequestメソッドを設定します。
パラメタ
request - HTTPリクエストオブジェクト
戻り値
なし
例外
なし
setResponse
形式

public void setResponse(HttpServletResponse response)

機能
getResponse()メソッドで戻されるHttpServletResponseメソッドを設定します。
パラメタ
response - HTTPレスポンスオブジェクト
戻り値
なし
例外
なし