SessionStore (NablarchApi)

java.lang.Object
- nablarch.common.web.session.SessionStore

直系の既知のサブクラス:

DbStore, HiddenStore, HttpSessionStore
```
@Published(tag="architect")
public abstract class SessionStore
extends Object
```
セッションの内容をストアに格納/読み込みするクラスが継承する共通実装。

作成者:

kawasima, tajima

関連項目:

nablarch.common.web.session.store

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

コンストラクタ
修飾子コンストラクタと説明

protected SessionStore(String name)
コンストラクタ。

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`SessionStore(String name)` コンストラクタ。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected List<SessionEntry>`	`decode(byte[] encoded)` セッションエントリリストをデコードする。
`abstract void`	`delete(String sessionId, ExecutionContext executionContext)` セッションの内容をストアから削除する。
`protected byte[]`	`encode(List<SessionEntry> entries)` セッションエントリリストをエンコードする。
`long`	`getExpiresMilliSeconds()` 有効期限(単位:ミリ秒)で取得する。
`String`	`getName()` セッションストア名を取得する。
`StateEncoder`	`getStateEncoder()` セッション内容の直列化モジュールを取得する。
`abstract void`	`invalidate(String sessionId, ExecutionContext executionContext)` セッションストアを無効にする。
`boolean`	`isExtendable()` セッション全体の有効期限に寄与するかを取得する。
`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`	`setName(String name)` セッションストア名を設定する。
`void`	`setStateEncoder(StateEncoder stateEncoder)` セッション内容の直列化モジュールを設定する。

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

クラス SessionStore

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

メソッドのサマリー

コンストラクタの詳細

SessionStore

メソッドの詳細

setName

getName

setExpires

setExpires

load

save

delete

invalidate

encode

decode

getExpiresMilliSeconds

isExtendable

getStateEncoder

setStateEncoder