ExecutionContext (NablarchApi)

java.lang.Object
- nablarch.fw.HandlerQueueManager<ExecutionContext>
- - nablarch.fw.ExecutionContext

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

ServletExecutionContext
```
public class ExecutionContext
extends nablarch.fw.HandlerQueueManager<ExecutionContext>
```
一連のハンドラ実行において、共通して読み書きするデータを保持するクラス。
具体的には以下の情報を保持する。
- ハンドラキュー
- データリーダもしくはデータリーダファクトリ
- ユーザセッションスコープ情報
- リクエストスコープ情報
本クラスのセッションスコープはスレッドアンセーフである。複数スレッドから使用する場合はセッションスコープにスレッドセーフなMap実装を設定すること。
作成者:

Iwauo Tajima

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

コンストラクタ
コンストラクタと説明

ExecutionContext()
デフォルトコンストラクタ

コンストラクタ
コンストラクタと説明
`ExecutionContext()` デフォルトコンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`int`	`getLastRecordNumber()` データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。
`<T> T`	`getRequestScopedVar(String varName)` リクエストスコープ上の変数の値を取得する。
`Map`	`getRequestScopeMap()` リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。
`<T> T`	`getSessionScopedVar(String varName)` セッションスコープ上の変数の値を取得する。
`Map`	`getSessionScopeMap()` セッションスコープ情報を格納したMapオブジェクトへの参照を返す。
`<TData,TResult> TResult`	`handleNext(TData data)` ハンドラキュー上の次のハンドラに処理を委譲する。
`ExecutionContext`	`invalidateSession()` 現在のリクエストに紐付けられたセッションスコープを無効化する。
`boolean`	`isNewSession()` 新規セッションであるかどうか。
`ExecutionContext`	`setRequestScopedVar(String varName, Object varValue)` リクエストスコープ上の変数の値を設定する。
`ExecutionContext`	`setSessionScopedVar(String varName, Object varValue)` セッションスコープ上の変数の値を設定する。

- コンストラクタの詳細
  - ExecutionContext
```
@Published(tag="architect")
public ExecutionContext()
```
    デフォルトコンストラクタ
- メソッドの詳細
  - handleNext
```
@Published
public <TData,TResult> TResult handleNext(TData data)
                                              throws NoMoreHandlerException
```
    ハンドラキュー上の次のハンドラに処理を委譲する。
    
    型パラメータ:
    
    TData - 処理対象データの型
    
    TResult - 処理結果データの型
    
    パラメータ:
    
    data - 処理対象データ
    
    戻り値:
    
    実行結果
    
    例外:
    
    NoMoreHandlerException - 次のハンドラが存在しない場合。
    
    ClassCastException - ハンドラの型変数と実際のハンドラの戻り値の型が異なる場合。
  - getRequestScopeMap
```
@Published
public Map getRequestScopeMap()
```
    リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。
    このMapへの変更はリクエストスコープに直接反映される。
    
    戻り値:
    
    リクエストスコープへの参照
  - getRequestScopedVar
```
@Published
public <T> T getRequestScopedVar(String varName)
```
    リクエストスコープ上の変数の値を取得する。
    
    型パラメータ:
    
    T - 期待する変数の型
    
    パラメータ:
    
    varName - 変数名
    
    戻り値:
    
    変数の値
    
    例外:
    
    ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。
  - setRequestScopedVar
```
@Published
public ExecutionContext setRequestScopedVar(String varName,
                                                       Object varValue)
```
    リクエストスコープ上の変数の値を設定する。
    既に定義済みの変数は上書きされる。
    
    パラメータ:
    
    varName - 変数名
    
    varValue - 変数の値
    
    戻り値:
    
    このオブジェクト自体
  - getSessionScopeMap
```
@Published
public Map getSessionScopeMap()
```
    セッションスコープ情報を格納したMapオブジェクトへの参照を返す。
    このMapへの変更はセッションスコープに直接反映される。
    
    戻り値:
    
    セッションスコープへの参照
  - getSessionScopedVar
```
@Published
public <T> T getSessionScopedVar(String varName)
```
    セッションスコープ上の変数の値を取得する。
    
    型パラメータ:
    
    T - 期待する変数の型
    
    パラメータ:
    
    varName - 変数名
    
    戻り値:
    
    変数の値
    
    例外:
    
    ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。
  - setSessionScopedVar
```
@Published
public ExecutionContext setSessionScopedVar(String varName,
                                                       Object varValue)
```
    セッションスコープ上の変数の値を設定する。
    既に定義済みの変数は上書きされる。
    
    パラメータ:
    
    varName - 変数名
    
    varValue - 変数の値
    
    戻り値:
    
    このオブジェクト自体
  - invalidateSession
```
@Published
public ExecutionContext invalidateSession()
```
    現在のリクエストに紐付けられたセッションスコープを無効化する。
    
    戻り値:
    
    このオブジェクト自体
  - isNewSession
```
@Published
public boolean isNewSession()
```
    新規セッションであるかどうか。
    
    戻り値:
    
    新規セッションである場合はtrue
  - getLastRecordNumber
```
@Published
public int getLastRecordNumber()
```
    データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。
    本メソッドは、FileDataReaderを使用してファイルを読み込んでいる場合にのみ値を返却する。 FileDataReader以外を使用している場合は0を返す。
    
    戻り値:
    
    現時点で物理的に読み込んでいるレコードのレコード番号

クラス ExecutionContext

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

メソッドのサマリー

コンストラクタの詳細

ExecutionContext

メソッドの詳細

handleNext

getRequestScopeMap

getRequestScopedVar

setRequestScopedVar

getSessionScopeMap

getSessionScopedVar

setSessionScopedVar

invalidateSession

isNewSession

getLastRecordNumber