nablarch.fw

Class ExecutionContext

java.lang.Object

nablarch.fw.HandlerQueueManager<ExecutionContext>

nablarch.fw.ExecutionContext

public class ExecutionContext
extends nablarch.fw.HandlerQueueManager<ExecutionContext>

一連のハンドラ実行において、共通して読み書きするデータを保持するクラス。

具体的には以下の情報を保持する。

• ハンドラキュー
• データリーダ もしくは データリーダファクトリ
• ユーザセッションスコープ情報
• リクエストスコープ情報

本クラスのセッションスコープはスレッドアンセーフである。 複数スレッドから使用する場合はセッションスコープにスレッドセーフなMap実装を設定すること。

Author:

Iwauo Tajima

Method Summary

Modifier and Type	Method and Description
int	getLastRecordNumber() データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。 本メソッドは、nablarch.fw.reader.FileDataReaderを使用してファイルを読み込んでいる場合にのみ値を返却する。 FileDataReader以外を使用している場合は0を返す。
<T> T	getRequestScopedVar(java.lang.String varName) リクエストスコープ上の変数の値を取得する。
java.util.Map	getRequestScopeMap() リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。 このMapへの変更はリクエストスコープに直接反映される。
<T> T	getSessionScopedVar(java.lang.String varName) セッションスコープ上の変数の値を取得する。
java.util.Map	getSessionScopeMap() セッションスコープ情報を格納したMapオブジェクトへの参照を返す。 このMapへの変更はセッションスコープに直接反映される。
<TData,TResult> TResult	handleNext(TData data) ハンドラキュー上の次のハンドラに処理を委譲する。
ExecutionContext	invalidateSession() 現在のリクエストに紐付けられたセッションスコープを無効化する。
boolean	isNewSession() 新規セッションであるかどうか。
ExecutionContext	setRequestScopedVar(java.lang.String varName, java.lang.Object varValue) リクエストスコープ上の変数の値を設定する。 既に定義済みの変数は上書きされる。
ExecutionContext	setSessionScopedVar(java.lang.String varName, java.lang.Object varValue) セッションスコープ上の変数の値を設定する。 既に定義済みの変数は上書きされる。

Method Detail

handleNext

@Published
public <TData,TResult> TResult handleNext(TData data)

ハンドラキュー上の次のハンドラに処理を委譲する。

Type Parameters:

TData - 処理対象データの型

TResult - 処理結果データの型

Parameters:

data - 処理対象データ

Returns:

実行結果

Throws:

nablarch.fw.NoMoreHandlerException - 次のハンドラが存在しない場合。

java.lang.ClassCastException - ハンドラの型変数と実際のハンドラの戻り値の型が異なる場合。

getRequestScopeMap

@Published
public java.util.Map getRequestScopeMap()

リクエストスコープ上の変数を格納したMapオブジェクトへの参照を返す。

このMapへの変更はリクエストスコープに直接反映される。

Returns:

リクエストスコープへの参照

getRequestScopedVar

@Published
public <T> T getRequestScopedVar(java.lang.String varName)

リクエストスコープ上の変数の値を取得する。

Type Parameters:

T - 期待する変数の型

Parameters:

varName - 変数名

Returns:

変数の値

Throws:

java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。

setRequestScopedVar

@Published
public ExecutionContext setRequestScopedVar(java.lang.String varName,
                                                       java.lang.Object varValue)

リクエストスコープ上の変数の値を設定する。

既に定義済みの変数は上書きされる。

Parameters:

varName - 変数名

varValue - 変数の値

Returns:

このオブジェクト自体

getSessionScopeMap

@Published
public java.util.Map getSessionScopeMap()

セッションスコープ情報を格納したMapオブジェクトへの参照を返す。

このMapへの変更はセッションスコープに直接反映される。

Returns:

セッションスコープへの参照

getSessionScopedVar

@Published
public <T> T getSessionScopedVar(java.lang.String varName)

セッションスコープ上の変数の値を取得する。

Type Parameters:

T - 期待する変数の型

Parameters:

varName - 変数名

Returns:

変数の値

Throws:

java.lang.ClassCastException - 実際の変数の型が期待する変数の型と適合しなかった場合。

setSessionScopedVar

@Published
public ExecutionContext setSessionScopedVar(java.lang.String varName,
                                                       java.lang.Object varValue)

セッションスコープ上の変数の値を設定する。

既に定義済みの変数は上書きされる。

Parameters:

varName - 変数名

varValue - 変数の値

Returns:

このオブジェクト自体

invalidateSession

@Published
public ExecutionContext invalidateSession()

現在のリクエストに紐付けられたセッションスコープを無効化する。

Returns:

このオブジェクト自体

isNewSession

@Published
public boolean isNewSession()

新規セッションであるかどうか。

Returns:

新規セッションである場合はtrue

getLastRecordNumber

@Published
public int getLastRecordNumber()

データリーダが、現時点で物理的に読み込んでいるレコードのレコード番号を返却する。

本メソッドは、nablarch.fw.reader.FileDataReaderを使用してファイルを読み込んでいる場合にのみ値を返却する。 FileDataReader以外を使用している場合は0を返す。

Returns:

現時点で物理的に読み込んでいるレコードのレコード番号