nablarch.fw.action

クラス BatchActionBase<D>

java.lang.Object

nablarch.core.db.support.DbAccessSupport

nablarch.fw.action.BatchActionBase<D>

型パラメータ:

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

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

nablarch.fw.handler.ExecutionHandlerCallback<CommandLine,Result>, nablarch.fw.TransactionEventCallback<D>

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

BatchAction, FileBatchActionBase

public abstract class BatchActionBase<D>
extends DbAccessSupport
implements nablarch.fw.handler.ExecutionHandlerCallback<CommandLine,Result>, nablarch.fw.TransactionEventCallback<D>

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

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

作成者:

Iwauo Tajima

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	error(Throwable error, ExecutionContext context) 実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。
protected void	initialize(CommandLine command, ExecutionContext context) 実行管理ハンドラ(ExecutionHandler)の本処理開始前に一度だけ実行される。
protected void	terminate(Result result, ExecutionContext context) 本処理が終了した場合に一度だけ実行される。
protected void	transactionFailure(D inputData, ExecutionContext context) トランザクション処理が異常終了した場合に実行される。
protected void	transactionSuccess(D inputData, ExecutionContext context) トランザクション処理が正常終了した場合に実行される。
protected void	writeErrorLog(Object data, String failureCode, Object... msgOptions) ERRORレベルで障害ログ出力を行う。
protected void	writeFatalLog(Object data, String failureCode, Object... msgOptions) FATALレベルで障害ログ出力を行う。
protected void	writeLog(String msgId, Object... msgOptions) INFOレベルでログ出力を行う。

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

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

メソッドの詳細

initialize

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

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

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

パラメータ:

command - 起動コマンドライン

context - 実行コンテキスト

error

@Published
protected void error(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(String msgId,
                                   Object... msgOptions)

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

パラメータ:

msgId - メッセージID

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

writeErrorLog

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

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

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

パラメータ:

data - 処理対象データ

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

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

writeFatalLog

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

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

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

パラメータ:

data - 処理対象データ

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

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