Package nablarch.common.web.session
Class SessionStore
java.lang.Object
nablarch.common.web.session.SessionStore
- Direct Known Subclasses:
DbStore
,HiddenStore
,HttpSessionStore
,LettuceRedisStore
セッションの内容をストアに格納/読み込みするクラスが継承する共通実装。
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected List<SessionEntry>
decode
(byte[] encoded) セッションエントリリストをデコードする。abstract void
delete
(String sessionId, ExecutionContext executionContext) セッションの内容をストアから削除する。protected byte[]
encode
(List<SessionEntry> entries) セッションエントリリストをエンコードする。long
有効期限(単位:ミリ秒)で取得する。getName()
セッションストア名を取得する。セッション内容の直列化モジュールを取得する。abstract void
invalidate
(String sessionId, ExecutionContext executionContext) セッションストアを無効にする。boolean
セッション全体の有効期限に寄与するかを取得する。 ストアの有効期限をセッショントラキングIDの保持期限に反映させない場合は、 本メソッドをサブクラス側でオーバーライドしてfalseを返却するようにする。abstract List<SessionEntry>
load
(String sessionId, ExecutionContext executionContext) セッションの内容をストアからロードする。 セッションの内容が存在しない場合は空リストを返す。abstract void
save
(String sessionId, List<SessionEntry> entries, ExecutionContext executionContext) セッションの内容をストアに保存する。void
setExpires
(Long expires) 有効期限(単位:秒)を設定する。void
setExpires
(Long expires, TimeUnit timeUnit) 有効期限を設定する。void
セッションストア名を設定する。void
setStateEncoder
(StateEncoder stateEncoder) セッション内容の直列化モジュールを設定する。
-
Constructor Details
-
SessionStore
コンストラクタ。 デフォルトのセッションストア名を設定する。- Parameters:
name
- セッションストア名
-
-
Method Details
-
setName
セッションストア名を設定する。- Parameters:
name
- セッションストア名
-
getName
セッションストア名を取得する。- Returns:
- セッションストア名
-
setExpires
有効期限(単位:秒)を設定する。- Parameters:
expires
- 有効期限(単位:秒)
-
setExpires
有効期限を設定する。- Parameters:
expires
- 有効期限timeUnit
- 時間単位
-
load
セッションの内容をストアからロードする。 セッションの内容が存在しない場合は空リストを返す。- Parameters:
sessionId
- セッションIDexecutionContext
- コンテキスト- Returns:
- セッションエントリリスト
-
save
public abstract void save(String sessionId, List<SessionEntry> entries, ExecutionContext executionContext) セッションの内容をストアに保存する。- Parameters:
sessionId
- セッションIDentries
- セッションエントリリストexecutionContext
- コンテキスト
-
delete
セッションの内容をストアから削除する。- Parameters:
sessionId
- セッションIDexecutionContext
- コンテキスト
-
invalidate
セッションストアを無効にする。- Parameters:
sessionId
- セッションIDexecutionContext
- コンテキスト
-
encode
セッションエントリリストをエンコードする。- Parameters:
entries
- セッションエントリリスト- Returns:
- バイト配列
-
decode
セッションエントリリストをデコードする。- Parameters:
encoded
- エンコードされたバイト配列- Returns:
- セッションエントリリスト
-
getExpiresMilliSeconds
public long getExpiresMilliSeconds()有効期限(単位:ミリ秒)で取得する。- Returns:
- 有効期限(単位:ミリ秒)
-
isExtendable
public boolean isExtendable()セッション全体の有効期限に寄与するかを取得する。 ストアの有効期限をセッショントラキングIDの保持期限に反映させない場合は、 本メソッドをサブクラス側でオーバーライドしてfalseを返却するようにする。- Returns:
- このストアの有効期限をセッションの維持期間に反映させる場合はtrue
-
getStateEncoder
セッション内容の直列化モジュールを取得する。- Returns:
- セッション内容の直列化モジュール
-
setStateEncoder
セッション内容の直列化モジュールを設定する。- Parameters:
stateEncoder
- セッション内容の直列化モジュール
-