nablarch.fw.action

クラス BatchActionBase<D>

java.lang.Object

nablarch.core.db.support.DbAccessSupport

nablarch.fw.action.BatchActionBase<D>

型パラメータ:

D - 本タスクが処理する入力データの型

すべての実装されたインタフェース:

ExecutionHandlerCallback<CommandLine,Result>, TransactionEventCallback<D>

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

BatchAction, FileBatchActionBase

public abstract class BatchActionBase<D>
extends DbAccessSupport
implements ExecutionHandlerCallback<CommandLine,Result>, TransactionEventCallback<D>

バッチ処理方式において、業務処理が継承する抽象基底クラス。

このクラスには、ExecutionHandlerCallbackインタフェースに関するNOP実装が与えられており、 必要に応じてオーバーライドできるようになっている。

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.TransactionEventCallback

TransactionEventCallback.Provider<TData>

フィールドのサマリー

インタフェースから継承されたフィールド nablarch.fw.TransactionEventCallback

REQUEST_DATA_REQUEST_SCOPE_KEY

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

コンストラクタ

コンストラクタと説明
BatchActionBase()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	error(java.lang.Throwable error, ExecutionContext context) 実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。
void	errorInExecution(java.lang.Throwable error, ExecutionContext context) 実行制御ハンドラが後続処理を実行した後、 後続のハンドラでエラーが発生した場合に呼ばれる。
protected void	initialize(CommandLine command, ExecutionContext context) 実行管理ハンドラ(ExecutionHandler)の本処理開始前に一度だけ実行される。
void	postExecution(Result result, ExecutionContext context) 実行制御ハンドラが後続処理を実行した後、正常、異常終了を問わず 処理が全て完了した直後に呼ばれる。
void	preExecution(CommandLine commandLine, ExecutionContext context) 実行制御ハンドラが後続処理を実行する前にコールバックされる。
protected void	terminate(Result result, ExecutionContext context) 本処理が終了した場合に一度だけ実行される。
void	transactionAbnormalEnd(java.lang.Throwable e, D data, ExecutionContext ctx) 入力データに対する処理で異常が発生した場合に呼ばれる。
protected void	transactionFailure(D inputData, ExecutionContext context) トランザクション処理が異常終了した場合に実行される。
void	transactionNormalEnd(D data, ExecutionContext ctx) 入力データに対する処理が正常に処理された場合に呼ばれる。
protected void	transactionSuccess(D inputData, ExecutionContext context) トランザクション処理が正常終了した場合に実行される。
protected void	writeErrorLog(java.lang.Object data, java.lang.String failureCode, java.lang.Object... msgOptions) ERRORレベルで障害ログ出力を行う。
protected void	writeFatalLog(java.lang.Object data, java.lang.String failureCode, java.lang.Object... msgOptions) FATALレベルで障害ログ出力を行う。
protected void	writeLog(java.lang.String msgId, java.lang.Object... msgOptions) INFOレベルでログ出力を行う。

クラスから継承されたメソッド nablarch.core.db.support.DbAccessSupport

countByParameterizedSql, countByStatementSql, getParameterizedSqlStatement, getParameterizedSqlStatement, getSqlCStatement, getSqlPStatement, search

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

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

コンストラクタの詳細

BatchActionBase

public BatchActionBase()

メソッドの詳細

initialize

@Published
protected void initialize(CommandLine command,
                                     ExecutionContext context)

実行管理ハンドラ(ExecutionHandler)の本処理開始前に一度だけ実行される。

デフォルトでは何もしない。 必要に応じてオーバライドすること。

パラメータ:

command - 起動コマンドライン

context - 実行コンテキスト

error

@Published
protected void error(java.lang.Throwable error,
                                ExecutionContext context)

実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。

デフォルトでは何もしない。 必要に応じてオーバライドすること。

パラメータ:

error - 本処理で発生した実行時例外/エラー

context - 実行コンテキスト

terminate

@Published
protected void terminate(Result result,
                                    ExecutionContext context)

本処理が終了した場合に一度だけ実行される。 （エラー終了した場合でも実行される。）

デフォルトでは何もしない。 必要に応じてオーバライドすること。

パラメータ:

result - 本処理の実行結果

context - 実行コンテキスト

transactionSuccess

@Published
protected void transactionSuccess(D inputData,
                                             ExecutionContext context)

トランザクション処理が正常終了した場合に実行される。

デフォルトでは何もしない。 必要に応じてオーバライドすること。

パラメータ:

inputData - 入力データ

context - 実行コンテキスト

transactionFailure

@Published
protected void transactionFailure(D inputData,
                                             ExecutionContext context)

トランザクション処理が異常終了した場合に実行される。

デフォルトでは何もしない。 必要に応じてオーバライドすること。

パラメータ:

inputData - 入力データ

context - 実行コンテキスト

writeLog

@Published
protected void writeLog(java.lang.String msgId,
                                   java.lang.Object... msgOptions)

INFOレベルでログ出力を行う。

パラメータ:

msgId - メッセージID

msgOptions - メッセージIDから取得したメッセージに埋め込む値

writeErrorLog

@Published
protected void writeErrorLog(java.lang.Object data,
                                        java.lang.String failureCode,
                                        java.lang.Object... msgOptions)

ERRORレベルで障害ログ出力を行う。

障害ログは、障害通知ログと障害解析ログの２種類に分けて出力される。

パラメータ:

data - 処理対象データ

failureCode - 障害コード（メッセージID）

msgOptions - 障害コードから取得したメッセージに埋め込む値

writeFatalLog

@Published
protected void writeFatalLog(java.lang.Object data,
                                        java.lang.String failureCode,
                                        java.lang.Object... msgOptions)

FATALレベルで障害ログ出力を行う。

障害ログは、障害通知ログと障害解析ログの２種類に分けて出力される。

パラメータ:

data - 処理対象データ

failureCode - 障害コード（メッセージID）

msgOptions - 障害コードから取得したメッセージに埋め込む値

preExecution

@Published(tag="architect")
public final void preExecution(CommandLine commandLine,
                                                           ExecutionContext context)

インタフェースからコピーされた説明: ExecutionHandlerCallback

実行制御ハンドラが後続処理を実行する前にコールバックされる。 一括処理実行前に、なんらかの初期処理を行う場合に実装する。

定義:

preExecution インタフェース内 ExecutionHandlerCallback<CommandLine,Result>

パラメータ:

commandLine - 入力データ

context - 実行コンテキスト

errorInExecution

@Published(tag="architect")
public final void errorInExecution(java.lang.Throwable error,
                                                               ExecutionContext context)

インタフェースからコピーされた説明: ExecutionHandlerCallback

実行制御ハンドラが後続処理を実行した後、 後続のハンドラでエラーが発生した場合に呼ばれる。

定義:

errorInExecution インタフェース内 ExecutionHandlerCallback<CommandLine,Result>

パラメータ:

error - 後続ハンドラの処理中に発生した実行時例外/エラー

context - 実行コンテキスト

postExecution

@Published(tag="architect")
public final void postExecution(Result result,
                                                            ExecutionContext context)

インタフェースからコピーされた説明: ExecutionHandlerCallback

実行制御ハンドラが後続処理を実行した後、正常、異常終了を問わず 処理が全て完了した直後に呼ばれる。 すなわち、正常終了時には、 の後、異常終了時には ExecutionHandlerCallback.errorInExecution(Throwable, ExecutionContext) の後で本メソッドが呼ばれる。

定義:

postExecution インタフェース内 ExecutionHandlerCallback<CommandLine,Result>

パラメータ:

result - ハンドラの戻り値となるオブジェクト

context - 実行コンテキスト

transactionNormalEnd

@Published(tag="architect")
public void transactionNormalEnd(D data,
                                                             ExecutionContext ctx)

インタフェースからコピーされた説明: TransactionEventCallback

入力データに対する処理が正常に処理された場合に呼ばれる。

定義:

transactionNormalEnd インタフェース内 TransactionEventCallback<D>

パラメータ:

data - 入力データ

ctx - 実行コンテキスト

transactionAbnormalEnd

@Published(tag="architect")
public void transactionAbnormalEnd(java.lang.Throwable e,
                                                               D data,
                                                               ExecutionContext ctx)

インタフェースからコピーされた説明: TransactionEventCallback

入力データに対する処理で異常が発生した場合に呼ばれる。

定義:

transactionAbnormalEnd インタフェース内 TransactionEventCallback<D>

パラメータ:

e - 発生したエラー

data - 入力データ

ctx - 実行コンテキスト