ExecutionContext (Nablarch-API)

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

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

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

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`static java.lang.String`	`FW_PREFIX` 各種スコープ上の変数をフレームワークが使用する際に名前に付けるプレフィックス（予約名）
`static java.lang.String`	`THROWN_APPLICATION_EXCEPTION_KEY` `ApplicationException`をリクエストスコープから取得する際に使用するキー
`static java.lang.String`	`THROWN_EXCEPTION_KEY` 例外をリクエストスコープから取得する際に使用するキー

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

コンストラクタ
コンストラクタと説明
`ExecutionContext()` デフォルトコンストラクタ
`ExecutionContext(ExecutionContext original)` 元となる実行コンテキストから、新たな実行コンテキストのオブジェクトを作成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`clearLastReadData()` この実行コンテキストが最後に読み込んだデータオブジェクトをクリアする。
`ExecutionContext`	`closeReader()` 現在使用しているデータリーダを閉じる。
`<T> T`	`findHandler(java.lang.Object data, java.lang.Class<T> targetType, java.lang.Class<?> stopType)` ハンドラキュー上の後続ハンドラのうち、指定されたクラスもしくはインタフェースを実装している直近のハンドラを返す。
`ApplicationException`	`getApplicationException()` リクエストスコープから`ApplicationException`を取得する。
`java.lang.Object`	`getCurrentRequestObject()` 現在処理中のリクエストオブジェクトを取得する。
`java.lang.Object`	`getDataProcessedWhenThrown(java.lang.Throwable e)` 指定した例外を送出したスレッドが、例外発生時に処理していた入力データを返す。
`<TData> DataReader<TData>`	`getDataReader()` データリーダを取得する。
`java.lang.Throwable`	`getException()` リクエストスコープから例外を取得する。
`java.util.List<Handler>`	`getHandlerQueue()` 現在のハンドラキューの内容を返す。
`<TData> TData`	`getLastReadData()` この実行コンテキストが最後に読み込んだデータオブジェクトを返す。
`int`	`getLastRecordNumber()` データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。
`<TData,TResult> Handler<TData,TResult>`	`getNextHandler()` ハンドラキュー上の次のハンドラを取得する。
`<T> T`	`getRequestScopedVar(java.lang.String varName)` リクエストスコープ上の変数の値を取得する。
`java.util.Map<java.lang.String,java.lang.Object>`	`getRequestScopeMap()` リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。
`<T> T`	`getSessionScopedVar(java.lang.String varName)` セッションスコープ上の変数の値を取得する。
`java.util.Map<java.lang.String,java.lang.Object>`	`getSessionScopeMap()` セッションスコープ情報を格納したMapオブジェクトへの参照を返す。
`<T> T`	`getSessionStoredVar(java.lang.String varName)` セッションストア上の変数の値を取得する。
`java.util.Map<java.lang.String,java.lang.Object>`	`getSessionStoreMap()` セッションストア情報を格納したMapオブジェクトへの参照を返す。
`<TData,TResult> TResult`	`handleNext(TData data)` ハンドラキュー上の次のハンドラに処理を委譲する。
`boolean`	`hasNextData()` この実行コンテキスト上のデータリーダから次に読み出すことができるデータが残っているかどうか。
`boolean`	`hasSession()` セッションがあるかどうか。
`ExecutionContext`	`invalidateSession()` 現在のリクエストに紐付けられたセッションスコープを無効化する。
`boolean`	`isNewSession()` 新規セッションであるかどうか。
`boolean`	`isProcessSucceeded()` 処理が正常終了したかどうかを取得する。
`void`	`putDataOnException(java.lang.Throwable e, java.lang.Object data)` 例外に関連するデータを追加する。
`<TData> TData`	`readNextData()` この実行コンテキスト上のデータリーダを使用して、次のデータを読み込む。
`<T> java.util.List<T>`	`selectHandlers(java.lang.Object data, java.lang.Class<T> targetType, java.lang.Class<?> stopType)` ハンドラキュー上の後続ハンドラのうち、指定されたクラスもしくはインタフェースを実装しているものを全て返す。
`void`	`setCurrentRequestObject(java.lang.Object currentRequestObject)` 現在処理中のリクエストオブジェクトを設定する。
`<TData> ExecutionContext`	`setDataReader(DataReader<TData> reader)` データリーダを設定する。
`<TData> ExecutionContext`	`setDataReaderFactory(DataReaderFactory<TData> factory)` データリーダのファクトリを設定する。
`void`	`setException(java.lang.Throwable e)` リクエストスコープに例外を設定する。
`void`	`setLastRecordNumber(int lastRecordNumber)` データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を設定する。
`void`	`setProcessSucceeded(boolean processSucceeded)` 処理が正常終了したかどうかを設定する。
`ExecutionContext`	`setRequestScopedVar(java.lang.String varName, java.lang.Object varValue)` リクエストスコープ上の変数の値を設定する。
`ExecutionContext`	`setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> m)` リクエストスコープを設定する。
`ExecutionContext`	`setSessionScopedVar(java.lang.String varName, java.lang.Object varValue)` セッションスコープ上の変数の値を設定する。
`ExecutionContext`	`setSessionScopeMap(java.util.Map<java.lang.String,java.lang.Object> m)` セッションスコープ上の変数を格納したMapを設定する。
`ExecutionContext`	`setSessionStoredVar(java.lang.String varName, java.lang.Object varValue)` セッションストア上の変数の値を設定する。
`ExecutionContext`	`setSessionStoreMap(java.util.Map<java.lang.String,java.lang.Object> m)` セッションストア上の変数を格納したMapを設定する。

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager
addHandler, addHandler, addHandler, addHandler, addHandler, addHandlers, clearHandlers, getHandlerOf, getMethodBinder, setHandlerQueue, setMethodBinder

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - FW_PREFIX
```
public static final java.lang.String FW_PREFIX
```
    各種スコープ上の変数をフレームワークが使用する際に名前に付けるプレフィックス（予約名）
    
    関連項目:
    
    定数フィールド値
  - THROWN_EXCEPTION_KEY
```
public static final java.lang.String THROWN_EXCEPTION_KEY
```
    例外をリクエストスコープから取得する際に使用するキー
    
    関連項目:
    
    定数フィールド値
  - THROWN_APPLICATION_EXCEPTION_KEY
```
public static final java.lang.String THROWN_APPLICATION_EXCEPTION_KEY
```
    ApplicationExceptionをリクエストスコープから取得する際に使用するキー
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - ExecutionContext
```
@Published(tag="architect")
public ExecutionContext()
```
    デフォルトコンストラクタ
  - ExecutionContext
```
public ExecutionContext(ExecutionContext original)
```
    元となる実行コンテキストから、新たな実行コンテキストのオブジェクトを作成する。
    作成される実行コンテキストの状態は以下の通り。
    - ハンドラキューには、元のオブジェクトからシャローコピーを作成して設定する。
    - リクエストスコープには、新規インスタンスを設定する(コピーされない)。
    - それ以外のフィールドには、元のオブジェクトの参照を設定する。
    パラメータ:
    
    original - 元となる実行コンテキスト
- メソッドの詳細
  - getHandlerQueue
```
public java.util.List<Handler> getHandlerQueue()
```
    クラスからコピーされた説明: HandlerQueueManager
    
    現在のハンドラキューの内容を返す。
    
    定義:
    
    getHandlerQueue クラス内 HandlerQueueManager<ExecutionContext>
    
    戻り値:
    
    現在のハンドラキューの内容
  - handleNext
```
@Published
public <TData,TResult> TResult handleNext(TData data)
                                              throws NoMoreHandlerException,
                                                     java.lang.ClassCastException
```
    ハンドラキュー上の次のハンドラに処理を委譲する。
    
    型パラメータ:
    
    TData - 処理対象データの型
    
    TResult - 処理結果データの型
    
    パラメータ:
    
    data - 処理対象データ
    
    戻り値:
    
    実行結果
    
    例外:
    
    NoMoreHandlerException - 次のハンドラが存在しない場合。
    
    java.lang.ClassCastException - ハンドラの型変数と実際のハンドラの戻り値の型が異なる場合。
  - getNextHandler
```
public <TData,TResult> Handler<TData,TResult> getNextHandler()
                                                      throws NoMoreHandlerException,
                                                             java.lang.ClassCastException
```
    ハンドラキュー上の次のハンドラを取得する。
    
    型パラメータ:
    
    TData - 処理対象データの型
    
    TResult - 処理結果データの型
    
    戻り値:
    
    次のハンドラ
    
    例外:
    
    NoMoreHandlerException - 次のハンドラが存在しない場合。
    
    java.lang.ClassCastException - ハンドラの型変数と実際のハンドラの戻り値の型が異なる場合。
  - findHandler
```
public <T> T findHandler(java.lang.Object data,
                         java.lang.Class<T> targetType,
                         java.lang.Class<?> stopType)
```
    ハンドラキュー上の後続ハンドラのうち、指定されたクラスもしくはインタフェースを実装している直近のハンドラを返す。
    該当するハンドラが登録されていなかった場合はnullを返す。
    
    型パラメータ:
    
    T - 検索対象のハンドラ型
    
    パラメータ:
    
    data - このハンドラに対する入力オブジェクト
    
    targetType - 検索対象のハンドラ型
    
    stopType - このタイプのハンドラよりも後続にあるハンドラを検索対象から除外する。
    
    戻り値:
    
    検索結果 (該当するハンドラが存在しなかった場合はnullを返す。)
  - selectHandlers
```
public <T> java.util.List<T> selectHandlers(java.lang.Object data,
                                            java.lang.Class<T> targetType,
                                            java.lang.Class<?> stopType)
```
    ハンドラキュー上の後続ハンドラのうち、指定されたクラスもしくはインタフェースを実装しているものを全て返す。
    該当するハンドラが登録されていなかった場合は空のリストを返す。
    
    型パラメータ:
    
    T - 検索対象のハンドラ型
    
    パラメータ:
    
    data - このハンドラに対する入力オブジェクト
    
    targetType - 検索対象のハンドラ型
    
    stopType - このタイプのハンドラよりも後続にあるハンドラを検索対象から除外する。
    
    戻り値:
    
    検索結果
  - readNextData
```
public <TData> TData readNextData()
```
    この実行コンテキスト上のデータリーダを使用して、次のデータを読み込む。
    
    型パラメータ:
    
    TData - データリーダが読み込むデータの型
    
    戻り値:
    
    読み込んだデータ
  - getLastReadData
```
public <TData> TData getLastReadData()
```
    この実行コンテキストが最後に読み込んだデータオブジェクトを返す。
    
    型パラメータ:
    
    TData - データオブジェクトの型
    
    戻り値:
    
    この実行コンテキストが最後に読み込んだデータオブジェクト
  - clearLastReadData
```
public void clearLastReadData()
```
    この実行コンテキストが最後に読み込んだデータオブジェクトをクリアする。
  - putDataOnException
```
public void putDataOnException(java.lang.Throwable e,
                               java.lang.Object data)
```
    例外に関連するデータを追加する。
    指定された例外およびデータはリクエストスコープに保持する。
    
    パラメータ:
    
    e - 例外
    
    data - 例外に関連するデータ
  - getDataProcessedWhenThrown
```
public java.lang.Object getDataProcessedWhenThrown(java.lang.Throwable e)
```
    指定した例外を送出したスレッドが、例外発生時に処理していた入力データを返す。
    
    パラメータ:
    
    e - 例外
    
    戻り値:
    
    指定した例外を送出したスレッドが例外発生時に処理していた入力データ。存在しない場合はnull
  - hasNextData
```
public boolean hasNextData()
```
    この実行コンテキスト上のデータリーダから次に読み出すことができるデータが残っているかどうか。
    
    戻り値:
    
    次に読み出すデータが存在する場合はtrue
  - getDataReader
```
public <TData> DataReader<TData> getDataReader()
```
    データリーダを取得する。
    データリーダが設定されていない場合は、データリーダファクトリを使用してリーダを生成し、その結果を返す。ファクトリも設定されていない場合はnullを返す。
    
    型パラメータ:
    
    TData - データリーダが読み込むデータ型
    
    戻り値:
    
    データリーダ
  - setDataReader
```
public <TData> ExecutionContext setDataReader(DataReader<TData> reader)
```
    データリーダを設定する。
    
    型パラメータ:
    
    TData - データリーダが読み込むデータ型
    
    パラメータ:
    
    reader - データリーダ
    
    戻り値:
    
    このオブジェクト自体
  - setDataReaderFactory
```
public <TData> ExecutionContext setDataReaderFactory(DataReaderFactory<TData> factory)
```
    データリーダのファクトリを設定する。
    
    型パラメータ:
    
    TData - ファクトリが生成するデータリーダが読み込むデータ型
    
    パラメータ:
    
    factory - 設定するデータリーダファクトリ
    
    戻り値:
    
    このオブジェクト自体
  - closeReader
```
public ExecutionContext closeReader()
```
    現在使用しているデータリーダを閉じる。
    リーダを閉じる際に例外が発生した場合は、ワーニングログを出力し、処理を継続する。
    
    戻り値:
    
    このオブジェクト自体
  - getException
```
public java.lang.Throwable getException()
```
    リクエストスコープから例外を取得する。
    THROWN_EXCEPTION_KEYキーを使用する。
    
    戻り値:
    
    例外。リクエストスコープに例外が設定されていない場合はnull
  - getApplicationException
```
public ApplicationException getApplicationException()
```
    リクエストスコープからApplicationExceptionを取得する。
    THROWN_APPLICATION_EXCEPTION_KEYキーを使用する。
    
    戻り値:
    
    ApplicationException。リクエストスコープにApplicationExceptionが設定されていない場合はnull
  - setException
```
public void setException(java.lang.Throwable e)
```
    リクエストスコープに例外を設定する。
    THROWN_EXCEPTION_KEYキーに例外を設定する。さらに、例外がApplicationExceptionの場合は、 THROWN_APPLICATION_EXCEPTION_KEYキーにも設定する。
    
    パラメータ:
    
    e - 例外
  - isProcessSucceeded
```
public boolean isProcessSucceeded()
```
    処理が正常終了したかどうかを取得する。
    
    戻り値:
    
    正常終了した場合true
  - setCurrentRequestObject
```
public void setCurrentRequestObject(java.lang.Object currentRequestObject)
```
    現在処理中のリクエストオブジェクトを設定する。
    
    パラメータ:
    
    currentRequestObject - 現在処理中のリクエストオブジェクト
  - getCurrentRequestObject
```
public java.lang.Object getCurrentRequestObject()
```
    現在処理中のリクエストオブジェクトを取得する。
    本メソッドは、またはの処理中にリクエストオブジェクトを取得する際に使用する。
    
    戻り値:
    
    現在処理中のリクエストオブジェクト
  - setProcessSucceeded
```
public void setProcessSucceeded(boolean processSucceeded)
```
    処理が正常終了したかどうかを設定する。
    
    パラメータ:
    
    processSucceeded - 正常終了の場合true
  - setRequestScopeMap
```
public ExecutionContext setRequestScopeMap(java.util.Map<java.lang.String,java.lang.Object> m)
```
    リクエストスコープを設定する。
    
    パラメータ:
    
    m - リクエストスコープ上の変数を格納するMap
    
    戻り値:
    
    このオブジェクト自体
  - getRequestScopeMap
```
@Published
public java.util.Map<java.lang.String,java.lang.Object> getRequestScopeMap()
```
    リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。
    このMapへの変更はリクエストスコープに直接反映される。
    
    戻り値:
    
    リクエストスコープへの参照
  - getRequestScopedVar
```
@Published
public <T> T getRequestScopedVar(java.lang.String varName)
                                     throws java.lang.ClassCastException
```
    リクエストスコープ上の変数の値を取得する。
    
    型パラメータ:
    
    T - 期待する変数の型
    
    パラメータ:
    
    varName - 変数名
    
    戻り値:
    
    変数の値
    
    例外:
    
    java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。
  - setRequestScopedVar
```
@Published
public ExecutionContext setRequestScopedVar(java.lang.String varName,
                                                       java.lang.Object varValue)
```
    リクエストスコープ上の変数の値を設定する。
    既に定義済みの変数は上書きされる。
    
    パラメータ:
    
    varName - 変数名
    
    varValue - 変数の値
    
    戻り値:
    
    このオブジェクト自体
  - setSessionStoreMap
```
public ExecutionContext setSessionStoreMap(java.util.Map<java.lang.String,java.lang.Object> m)
```
    セッションストア上の変数を格納したMapを設定する。
    
    パラメータ:
    
    m - セッションストア上の変数を格納したMap
    
    戻り値:
    
    このオブジェクト自体
  - getSessionStoreMap
```
public java.util.Map<java.lang.String,java.lang.Object> getSessionStoreMap()
```
    セッションストア情報を格納したMapオブジェクトへの参照を返す。
    このMapへの変更はセッションストアに直接反映される。
    
    戻り値:
    
    セッションストアへの参照
  - getSessionStoredVar
```
public <T> T getSessionStoredVar(java.lang.String varName)
                          throws java.lang.ClassCastException
```
    セッションストア上の変数の値を取得する。
    
    型パラメータ:
    
    T - 期待する変数の型
    
    パラメータ:
    
    varName - 変数名
    
    戻り値:
    
    変数の値
    
    例外:
    
    java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。
  - setSessionStoredVar
```
public ExecutionContext setSessionStoredVar(java.lang.String varName,
                                            java.lang.Object varValue)
```
    セッションストア上の変数の値を設定する。
    既に定義済みの変数は上書きされる。
    
    パラメータ:
    
    varName - 変数名
    
    varValue - 変数の値
    
    戻り値:
    
    このオブジェクト自体
  - setSessionScopeMap
```
public ExecutionContext setSessionScopeMap(java.util.Map<java.lang.String,java.lang.Object> m)
```
    セッションスコープ上の変数を格納したMapを設定する。
    
    パラメータ:
    
    m - リクエストスコープ上の変数を格納したMap
    
    戻り値:
    
    このオブジェクト自体
  - getSessionScopeMap
```
@Published
public java.util.Map<java.lang.String,java.lang.Object> getSessionScopeMap()
```
    セッションスコープ情報を格納したMapオブジェクトへの参照を返す。
    このMapへの変更はセッションスコープに直接反映される。
    
    戻り値:
    
    セッションスコープへの参照
  - getSessionScopedVar
```
@Published
public <T> T getSessionScopedVar(java.lang.String varName)
                                     throws java.lang.ClassCastException
```
    セッションスコープ上の変数の値を取得する。
    
    型パラメータ:
    
    T - 期待する変数の型
    
    パラメータ:
    
    varName - 変数名
    
    戻り値:
    
    変数の値
    
    例外:
    
    java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。
  - setSessionScopedVar
```
@Published
public ExecutionContext setSessionScopedVar(java.lang.String varName,
                                                       java.lang.Object varValue)
```
    セッションスコープ上の変数の値を設定する。
    既に定義済みの変数は上書きされる。
    
    パラメータ:
    
    varName - 変数名
    
    varValue - 変数の値
    
    戻り値:
    
    このオブジェクト自体
  - invalidateSession
```
@Published
public ExecutionContext invalidateSession()
```
    現在のリクエストに紐付けられたセッションスコープを無効化する。
    
    戻り値:
    
    このオブジェクト自体
  - isNewSession
```
@Published
public boolean isNewSession()
```
    新規セッションであるかどうか。
    
    戻り値:
    
    新規セッションである場合はtrue
  - hasSession
```
public boolean hasSession()
```
    セッションがあるかどうか。
    
    戻り値:
    
    セッションがある場合[@code true}
  - setLastRecordNumber
```
public void setLastRecordNumber(int lastRecordNumber)
```
    データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を設定する。
    
    パラメータ:
    
    lastRecordNumber - 現時点で物理的に読み込んでいるレコードのレコード番号
  - getLastRecordNumber
```
@Published
public int getLastRecordNumber()
```
    データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。
    本メソッドは、FileDataReaderを使用してファイルを読み込んでいる場合にのみ値を返却する。 FileDataReader以外を使用している場合は0を返す。
    
    戻り値:
    
    現時点で物理的に読み込んでいるレコードのレコード番号

クラス ExecutionContext

フィールドのサマリー

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

メソッドのサマリー

クラスから継承されたメソッド nablarch.fw.HandlerQueueManager

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

フィールドの詳細

FW_PREFIX

THROWN_EXCEPTION_KEY

THROWN_APPLICATION_EXCEPTION_KEY

コンストラクタの詳細

ExecutionContext

ExecutionContext

メソッドの詳細

getHandlerQueue

handleNext

getNextHandler

findHandler

selectHandlers

readNextData

getLastReadData

clearLastReadData

putDataOnException

getDataProcessedWhenThrown

hasNextData

getDataReader

setDataReader

setDataReaderFactory

closeReader

getException

getApplicationException

setException

isProcessSucceeded

setCurrentRequestObject

getCurrentRequestObject

setProcessSucceeded

setRequestScopeMap

getRequestScopeMap

getRequestScopedVar

setRequestScopedVar

setSessionStoreMap

getSessionStoreMap

getSessionStoredVar

setSessionStoredVar

setSessionScopeMap

getSessionScopeMap

getSessionScopedVar

setSessionScopedVar

invalidateSession

isNewSession

hasSession

setLastRecordNumber

getLastRecordNumber