nablarch.common.web.session

クラス SessionStoreHandler

java.lang.Object

nablarch.common.web.session.SessionStoreHandler

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

Handler<java.lang.Object,java.lang.Object>

public class SessionStoreHandler
extends java.lang.Object
implements Handler<java.lang.Object,java.lang.Object>

ストアを選択できるセッション保存機能のためのハンドラ。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	IS_INVALIDATED_KEY セッションがinvalidateされたことを示すフラグを リクエストスコープに設定する際に使用するキー

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SessionStoreHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	handle(java.lang.Object data, ExecutionContext context) 入力データに対する処理を実行する。
protected HttpResponse	handleLoadFailed(java.lang.Object data, ExecutionContext context, java.lang.RuntimeException e) セッションのロード時に発生したRuntimeExceptionを処理する。
protected java.lang.String	readId(ServletExecutionContext context) クッキーからセッションIDを読み出す。
void	setCookieDomain(java.lang.String cookieDomain) セッションIDを保持するクッキーのdomain属性を設定する。
void	setCookieName(java.lang.String cookieName) セッションIDを保持するクッキーの名称を設定する。
void	setCookiePath(java.lang.String cookiePath) セッションIDを保持するクッキーのpath属性を設定する。
void	setCookieSecure(boolean cookieSecure) セッショントラッキングIDを保持するクッキーにsecure属性を指定するかどうかを設定する。
void	setSessionManager(SessionManager sessionManager) セッションマネージャを設定する。
protected void	setSessionTrackingCookie(Session session, javax.servlet.http.HttpServletResponse response) セッションIDを保持するためのクッキーをレスポンスのSet-Cookieヘッダに追加する。
protected void	writeId(Session session, ServletExecutionContext context) セッションIDを書き出す。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

IS_INVALIDATED_KEY

public static final java.lang.String IS_INVALIDATED_KEY

セッションがinvalidateされたことを示すフラグを リクエストスコープに設定する際に使用するキー

関連項目:

定数フィールド値

コンストラクタの詳細

SessionStoreHandler

public SessionStoreHandler()

メソッドの詳細

handleLoadFailed

protected HttpResponse handleLoadFailed(java.lang.Object data,
                                        ExecutionContext context,
                                        java.lang.RuntimeException e)

セッションのロード時に発生したRuntimeExceptionを処理する。

次の例外が発生した場合は、クライアントによる改竄の可能性があるため、 ステータスコード400のエラーレスポンスを返却する。

 ・HiddenStore.HiddenStoreLoadFailedException
 

それ以外は、指定された例外をそのまま再送出する。

パラメータ:

data - 入力データ

context - 実行コンテキスト

e - RuntimeException

戻り値:

レスポンスオブジェクト

handle

public java.lang.Object handle(java.lang.Object data,
                               ExecutionContext context)

インタフェースからコピーされた説明: Handler

入力データに対する処理を実行する。

定義:

handle インタフェース内 Handler<java.lang.Object,java.lang.Object>

パラメータ:

data - 入力データ

context - 実行コンテキスト

戻り値:

処理結果データ

writeId

protected void writeId(Session session,
                       ServletExecutionContext context)

セッションIDを書き出す。

パラメータ:

session - セッション

context - 実行コンテキスト

setSessionTrackingCookie

protected void setSessionTrackingCookie(Session session,
                                        javax.servlet.http.HttpServletResponse response)

セッションIDを保持するためのクッキーをレスポンスのSet-Cookieヘッダに追加する。

パラメータ:

session - セッション

response - サーブレットレスポンス

readId

protected java.lang.String readId(ServletExecutionContext context)

クッキーからセッションIDを読み出す。

パラメータ:

context - 実行コンテキスト

戻り値:

セッションID

setSessionManager

public void setSessionManager(SessionManager sessionManager)

セッションマネージャを設定する。

パラメータ:

sessionManager - セッションマネージャ

setCookieName

public void setCookieName(java.lang.String cookieName)

セッションIDを保持するクッキーの名称を設定する。 デフォルトは "NABLARCH_SID"

パラメータ:

cookieName - クッキー名

setCookiePath

public void setCookiePath(java.lang.String cookiePath)

セッションIDを保持するクッキーのpath属性を設定する。 デフォルトではホスト配下の全てのパスを送信対象とする。

パラメータ:

cookiePath - クッキーパス

setCookieDomain

public void setCookieDomain(java.lang.String cookieDomain)

セッションIDを保持するクッキーのdomain属性を設定する。 デフォルトでは未指定。 この場合、当該のクッキーは発行元ホストのみに送信される。

パラメータ:

cookieDomain - クッキードメイン

setCookieSecure

public void setCookieSecure(boolean cookieSecure)

セッショントラッキングIDを保持するクッキーにsecure属性を指定するかどうかを設定する。 trueに設定した場合、当該のクッキーはSSL接続されたリクエストでのみ送信される。 デフォルトはfalse。

パラメータ:

cookieSecure - セキュア属性を付けたいならばtrue