nablarch.common.web.session

Class SessionStore

java.lang.Object

nablarch.common.web.session.SessionStore

Direct Known Subclasses:

DbStore, HiddenStore, HttpSessionStore, LettuceRedisStore

@Published(tag="architect")
public abstract class SessionStore
extends java.lang.Object

セッションの内容をストアに格納/読み込みするクラスが継承する共通実装。

See Also:

nablarch.common.web.session.store

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SessionStore(java.lang.String name) コンストラクタ。 デフォルトのセッションストア名を設定する。

Method Summary

Modifier and Type	Method and Description
protected java.util.List<SessionEntry>	decode(byte[] encoded) セッションエントリリストをデコードする。
abstract void	delete(java.lang.String sessionId, ExecutionContext executionContext) セッションの内容をストアから削除する。
protected byte[]	encode(java.util.List<SessionEntry> entries) セッションエントリリストをエンコードする。
long	getExpiresMilliSeconds() 有効期限(単位:ミリ秒)で取得する。
java.lang.String	getName() セッションストア名を取得する。
StateEncoder	getStateEncoder() セッション内容の直列化モジュールを取得する。
abstract void	invalidate(java.lang.String sessionId, ExecutionContext executionContext) セッションストアを無効にする。
boolean	isExtendable() セッション全体の有効期限に寄与するかを取得する。 ストアの有効期限をセッショントラキングIDの保持期限に反映させない場合は、 本メソッドをサブクラス側でオーバーライドしてfalseを返却するようにする。
abstract java.util.List<SessionEntry>	load(java.lang.String sessionId, ExecutionContext executionContext) セッションの内容をストアからロードする。 セッションの内容が存在しない場合は空リストを返す。
abstract void	save(java.lang.String sessionId, java.util.List<SessionEntry> entries, ExecutionContext executionContext) セッションの内容をストアに保存する。
void	setExpires(java.lang.Long expires) 有効期限(単位:秒)を設定する。
void	setExpires(java.lang.Long expires, java.util.concurrent.TimeUnit timeUnit) 有効期限を設定する。
void	setName(java.lang.String name) セッションストア名を設定する。
void	setStateEncoder(StateEncoder stateEncoder) セッション内容の直列化モジュールを設定する。

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionStore

protected SessionStore(java.lang.String name)

コンストラクタ。 デフォルトのセッションストア名を設定する。

Parameters:

name - セッションストア名

Method Detail

setName

public void setName(java.lang.String name)

セッションストア名を設定する。

Parameters:

name - セッションストア名

getName

public java.lang.String getName()

セッションストア名を取得する。

Returns:

セッションストア名

setExpires

public void setExpires(java.lang.Long expires)

有効期限(単位:秒)を設定する。

Parameters:

expires - 有効期限(単位:秒)

setExpires

public void setExpires(java.lang.Long expires,
                       java.util.concurrent.TimeUnit timeUnit)

有効期限を設定する。

Parameters:

expires - 有効期限

timeUnit - 時間単位

load

public abstract java.util.List<SessionEntry> load(java.lang.String sessionId,
                                                  ExecutionContext executionContext)

セッションの内容をストアからロードする。 セッションの内容が存在しない場合は空リストを返す。

Parameters:

sessionId - セッションID

executionContext - コンテキスト

Returns:

セッションエントリリスト

save

public abstract void save(java.lang.String sessionId,
                          java.util.List<SessionEntry> entries,
                          ExecutionContext executionContext)

セッションの内容をストアに保存する。

Parameters:

sessionId - セッションID

entries - セッションエントリリスト

executionContext - コンテキスト

delete

public abstract void delete(java.lang.String sessionId,
                            ExecutionContext executionContext)

セッションの内容をストアから削除する。

Parameters:

sessionId - セッションID

executionContext - コンテキスト

invalidate

public abstract void invalidate(java.lang.String sessionId,
                                ExecutionContext executionContext)

セッションストアを無効にする。

Parameters:

sessionId - セッションID

executionContext - コンテキスト

encode

protected byte[] encode(java.util.List<SessionEntry> entries)

セッションエントリリストをエンコードする。

Parameters:

entries - セッションエントリリスト

Returns:

バイト配列

decode

protected java.util.List<SessionEntry> decode(byte[] encoded)

セッションエントリリストをデコードする。

Parameters:

encoded - エンコードされたバイト配列

Returns:

セッションエントリリスト

getExpiresMilliSeconds

public long getExpiresMilliSeconds()

有効期限(単位:ミリ秒)で取得する。

Returns:

有効期限(単位:ミリ秒)

isExtendable

public boolean isExtendable()

セッション全体の有効期限に寄与するかを取得する。 ストアの有効期限をセッショントラキングIDの保持期限に反映させない場合は、 本メソッドをサブクラス側でオーバーライドしてfalseを返却するようにする。

Returns:

このストアの有効期限をセッションの維持期間に反映させる場合はtrue

getStateEncoder

public StateEncoder getStateEncoder()

セッション内容の直列化モジュールを取得する。

Returns:

セッション内容の直列化モジュール

setStateEncoder

public void setStateEncoder(StateEncoder stateEncoder)

セッション内容の直列化モジュールを設定する。

Parameters:

stateEncoder - セッション内容の直列化モジュール