wisdom.core.session
クラス UserSession

java.lang.Object
  wisdom.core.CoreObject
      wisdom.core.session.UserSession

すべての実装インタフェース:

java.util.EventListener, javax.servlet.http.HttpSessionBindingListener, IUserSession, java.io.Serializable

public class UserSession

extends CoreObject

implements IUserSession, java.io.Serializable, javax.servlet.http.HttpSessionBindingListener

IUserSessionの実装クラスです。

バージョン:

1

作成者:

Takao Kouda

関連項目:

直列化された形式

フィールドの概要

インタフェース wisdom.core.application.IUserSession から継承したフィールド

SESSION_NAME

メソッドの概要

void	addUnremovableSessionAttributeName(java.lang.String key) 除去不能なセッション情報を登録します。
void	addUnremovableSessionAttributeNames(java.lang.String[] keys) 除去不能なセッション情報を登録します。
void	cleanupRemovableSessionAttributes() 除去可能なセッション属性をすべてクリアします。
java.lang.Object	getAttribute(java.lang.String key) 指定されたキー値でセッション情報を取得します。
java.lang.Object	getAttribute(java.lang.String key, boolean allowNull) 指定されたキー値でセッション情報を取得します。
java.util.Iterator	getAttributeNames() キー値のリストを戻します。
javax.servlet.http.HttpSession	getHttpSession() このUserSessionオブジェクトを格納しているHttpSessionオブジェクトを取得します。
java.lang.String	getName() ユーザー名を取得します
java.lang.String	getPageHistory(int historyNo) 送りページの履歴を取得します。
java.util.List	getRecentPages() 送りページの履歴をStringは配列をListで取得します。
java.util.List	getRecentReqids() Reqidの履歴を含んだSting配列をListで取得します。
java.lang.String	getReqidHistory(int historyNo) Reqidの履歴を取得します。
java.util.List	getUnremovableSessionAttributeNames() 除去不能なセッション情報のキー名を取得します。
java.lang.String	getUserid() ユーザーIDを取得します
boolean	isAuthenticated() このユーザーが認証済かを検査します
void	logOut() ログアウト処理を行います。
void	removeAttribute(java.lang.String key) 指定されたキー値で設定されたオブジェクト除外します。
void	removeUnremovableSessionAttributeName(java.lang.String key) 除去不能なセッション情報を削除します。
void	setAttribute(java.lang.String key, java.lang.Object object) セッション情報を指定されたキー値で設定します。
void	setRecentPage(java.lang.String page) 最新の送り先ページを設定します。
void	setRecentReqid(java.lang.String reqid) 最新のreqidを設定します。
java.lang.String	toString()
void	valueBound(javax.servlet.http.HttpSessionBindingEvent event)
void	valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

クラス java.lang.Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

メソッドの詳細

getUserid

public java.lang.String getUserid()

インタフェース IUserSession の記述:

ユーザーIDを取得します

定義:

インタフェース IUserSession 内の getUserid

戻り値:

ユーザーID

getName

public java.lang.String getName()

インタフェース IUserSession の記述:

ユーザー名を取得します

定義:

インタフェース IUserSession 内の getName

戻り値:

ユーザー名

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object object)

インタフェース IUserSession の記述:

セッション情報を指定されたキー値で設定します。

定義:

インタフェース IUserSession 内の setAttribute

パラメータ:

key - 設定するセッション情報のキー値 param object 設定するセッション情報

removeAttribute

public void removeAttribute(java.lang.String key)

インタフェース IUserSession の記述:

指定されたキー値で設定されたオブジェクト除外します。 該当するキー値で設定されていない場合は何もしません。

定義:

インタフェース IUserSession 内の removeAttribute

パラメータ:

key - 除外するセッション情報のキー値

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
                              throws MissingSessionObjectException

インタフェース IUserSession の記述:

指定されたキー値でセッション情報を取得します。

定義:

インタフェース IUserSession 内の getAttribute

パラメータ:

key - 取得するセッション情報のキー値

例外:

MissingSessionObjectException - 指定されたキー値でセッション情報が設定されていない場合

getAttribute

public java.lang.Object getAttribute(java.lang.String key,
                                     boolean allowNull)
                              throws MissingSessionObjectException

インタフェース IUserSession の記述:

指定されたキー値でセッション情報を取得します。

定義:

インタフェース IUserSession 内の getAttribute

パラメータ:

key - 取得するセッション情報のキー値

allowNull - 取得するセッション情報がnullの場合も許可する。

例外:

MissingSessionObjectException - 指定されたキー値でセッション情報が設定されていない場合

getAttributeNames

public java.util.Iterator getAttributeNames()

インタフェース IUserSession の記述:

キー値のリストを戻します。

定義:

インタフェース IUserSession 内の getAttributeNames

戻り値:

Enumeration キー値のリスト

setRecentPage

public void setRecentPage(java.lang.String page)

インタフェース IUserSession の記述:

最新の送り先ページを設定します。 このメソッドはフレームワーク内部で設定されます。

定義:

インタフェース IUserSession 内の setRecentPage

パラメータ:

page - 送られた最新のページ

setRecentReqid

public void setRecentReqid(java.lang.String reqid)

インタフェース IUserSession の記述:

最新のreqidを設定します。 このメソッドはフレームワーク内部で設定されます。

定義:

インタフェース IUserSession 内の setRecentReqid

パラメータ:

reqid - 最新のreqid

getPageHistory

public java.lang.String getPageHistory(int historyNo)

インタフェース IUserSession の記述:

送りページの履歴を取得します。履歴の開始番号は0です。

定義:

インタフェース IUserSession 内の getPageHistory

パラメータ:

historyNo -

戻り値:

String

getReqidHistory

public java.lang.String getReqidHistory(int historyNo)

インタフェース IUserSession の記述:

Reqidの履歴を取得します。履歴の開始番号は0です。

定義:

インタフェース IUserSession 内の getReqidHistory

パラメータ:

historyNo -

戻り値:

String

getRecentPages

public java.util.List getRecentPages()

インタフェース IUserSession の記述:

送りページの履歴をStringは配列をListで取得します。

定義:

インタフェース IUserSession 内の getRecentPages

戻り値:

送りページの履歴

getRecentReqids

public java.util.List getRecentReqids()

インタフェース IUserSession の記述:

Reqidの履歴を含んだSting配列をListで取得します。

定義:

インタフェース IUserSession 内の getRecentReqids

戻り値:

Reqidの履歴

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

インタフェース IUserSession の記述:

このUserSessionオブジェクトを格納しているHttpSessionオブジェクトを取得します。

定義:

インタフェース IUserSession 内の getHttpSession

戻り値:

HttpSession このUserSessionオブジェクトを格納しているHttpSessionオブジェクト

cleanupRemovableSessionAttributes

public void cleanupRemovableSessionAttributes()

インタフェース IUserSession の記述:

除去可能なセッション属性をすべてクリアします。
addtUnemovableSessionAttributeNameで登録された以外のセッション属性を すべてremoveします。

定義:

インタフェース IUserSession 内の cleanupRemovableSessionAttributes

addUnremovableSessionAttributeName

public void addUnremovableSessionAttributeName(java.lang.String key)

インタフェース IUserSession の記述:

除去不能なセッション情報を登録します。
cleanupRemovableSessionAttributesでクリア対象外にするセッション情報のkeyを登録します。 登録されたkeyを持つセッション情報はcleanupRemovableSessionAttributesでクリアされません。

定義:

インタフェース IUserSession 内の addUnremovableSessionAttributeName

パラメータ:

key - 除去不能なセッション情報として登録するセッション情報のキー

addUnremovableSessionAttributeNames

public void addUnremovableSessionAttributeNames(java.lang.String[] keys)

インタフェース IUserSession の記述:

除去不能なセッション情報を登録します。
cleanupRemovableSessionAttributesでクリア対象外にするセッション情報のkeyを登録します。 登録されたkeyを持つセッション情報はcleanupRemovableSessionAttributesでクリアされません。

定義:

インタフェース IUserSession 内の addUnremovableSessionAttributeNames

パラメータ:

keys - 除去不能なセッション情報として登録するセッション情報のキーの配列

removeUnremovableSessionAttributeName

public void removeUnremovableSessionAttributeName(java.lang.String key)

インタフェース IUserSession の記述:

除去不能なセッション情報を削除します。
addUnremovableSessionAttributeName、 addUnremovableSessionAttributeNames クリア対象外として登録されたkeyを削除します。

定義:

インタフェース IUserSession 内の removeUnremovableSessionAttributeName

パラメータ:

key - 除去不能なセッション情報を削除するセッション情報のキー

getUnremovableSessionAttributeNames

public java.util.List getUnremovableSessionAttributeNames()

インタフェース IUserSession の記述:

除去不能なセッション情報のキー名を取得します。

定義:

インタフェース IUserSession 内の getUnremovableSessionAttributeNames

戻り値:

addUnremovableSessionAttributeName、 addUnremovableSessionAttributeNamesで登録された除去不能なセッション情報のキー値を含んだ配列。

logOut

public void logOut()

インタフェース IUserSession の記述:

ログアウト処理を行います。

定義:

インタフェース IUserSession 内の logOut

valueBound

public void valueBound(javax.servlet.http.HttpSessionBindingEvent event)

定義:

インタフェース javax.servlet.http.HttpSessionBindingListener 内の valueBound

valueUnbound

public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent event)

定義:

インタフェース javax.servlet.http.HttpSessionBindingListener 内の valueUnbound

toString

public java.lang.String toString()

isAuthenticated

public boolean isAuthenticated()

インタフェース IUserSession の記述:

このユーザーが認証済かを検査します

定義:

インタフェース IUserSession 内の isAuthenticated