wisdom.core.application
インタフェース IUserSession

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

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

既知の実装クラスの一覧:

UserSession

public interface IUserSession

extends java.io.Serializable, javax.servlet.http.HttpSessionBindingListener

セッション情報へのアクセス方法を定義したインターフェース。
セッション情報へのアクセスはHttpSessionではなく、このインターフェースを使用して行います。
このオブジェクトのインスタンスは ServletRuntimeConfig.isEnablesSession() がtrueのときに使用可能に なります。認証済か否かはServletRuntimeConfig.isAuthenticateRequired() の設定に依存します。

バージョン:

1

作成者:

Takao Kouda

関連項目:

RunTimeServlet, ServletRuntimeConfig, IAuthenticate

フィールドの概要

static java.lang.String

SESSION_NAME HttpSessionにこのオブジェクトを put する際のキー値。

メソッドの概要

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を設定します。

インタフェース javax.servlet.http.HttpSessionBindingListener から継承したメソッド

valueBound, valueUnbound

フィールドの詳細

SESSION_NAME

public static final java.lang.String SESSION_NAME

HttpSessionにこのオブジェクトを put する際のキー値。

関連項目:

定数フィールド値

メソッドの詳細

getUserid

public java.lang.String getUserid()

ユーザーIDを取得します

戻り値:

ユーザーID

getName

public java.lang.String getName()

ユーザー名を取得します

戻り値:

ユーザー名

isAuthenticated

public boolean isAuthenticated()

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

setAttribute

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

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

パラメータ:

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

removeAttribute

public void removeAttribute(java.lang.String key)

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

パラメータ:

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

getAttribute

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

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

パラメータ:

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

例外:

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

getAttribute

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

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

パラメータ:

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

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

例外:

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

getAttributeNames

public java.util.Iterator getAttributeNames()

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

戻り値:

Enumeration キー値のリスト

setRecentPage

public void setRecentPage(java.lang.String page)

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

パラメータ:

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

setRecentReqid

public void setRecentReqid(java.lang.String reqid)

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

パラメータ:

reqid - 最新のreqid

getPageHistory

public java.lang.String getPageHistory(int historyNo)

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

パラメータ:

historyNo -

戻り値:

String

getReqidHistory

public java.lang.String getReqidHistory(int historyNo)

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

パラメータ:

historyNo -

戻り値:

String

getRecentPages

public java.util.List getRecentPages()

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

戻り値:

送りページの履歴

getRecentReqids

public java.util.List getRecentReqids()

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

戻り値:

Reqidの履歴

getHttpSession

public javax.servlet.http.HttpSession getHttpSession()

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

戻り値:

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

cleanupRemovableSessionAttributes

public void cleanupRemovableSessionAttributes()

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

addUnremovableSessionAttributeName

public void addUnremovableSessionAttributeName(java.lang.String key)

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

パラメータ:

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

addUnremovableSessionAttributeNames

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

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

パラメータ:

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

removeUnremovableSessionAttributeName

public void removeUnremovableSessionAttributeName(java.lang.String key)

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

パラメータ:

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

getUnremovableSessionAttributeNames

public java.util.List getUnremovableSessionAttributeNames()

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

戻り値:

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

logOut

public void logOut()

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