BatchActionBase (NablarchApi)

java.lang.Object
- nablarch.core.db.support.DbAccessSupport
- - nablarch.fw.action.BatchActionBase<D>

Type Parameters:

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BatchAction, FileBatchActionBase
```
public abstract class BatchActionBase<D>
extends DbAccessSupport
implements ExecutionHandlerCallback<CommandLine,Result>, nablarch.fw.TransactionEventCallback<D>
```
バッチ処理方式において、業務処理が継承する抽象基底クラス。
このクラスには、ExecutionHandlerCallbackインタフェースに関するNOP実装が与えられており、必要に応じてオーバーライドできるようになっている。

Author:

Iwauo Tajima

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` 実行制御ハンドラが後続処理を実行した後、正常、異常終了を問わず処理が全て完了した直後に呼ばれる。すなわち、正常終了時には、の後、異常終了時には `ExecutionHandlerCallback.errorInExecution(Throwable, ExecutionContext)` の後で本メソッドが呼ばれる。
`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レベルでログ出力を行う。

Methods inherited from class nablarch.core.db.support.DbAccessSupport
countByParameterizedSql, countByStatementSql, getParameterizedSqlStatement, getParameterizedSqlStatement, getSqlCStatement, getSqlPStatement, search

- Method Detail
  - initialize
```
@Published
protected void initialize(CommandLine command,
                                     ExecutionContext context)
```
    実行管理ハンドラ(ExecutionHandler)の本処理開始前に一度だけ実行される。
    デフォルトでは何もしない。必要に応じてオーバライドすること。
    
    Parameters:
    
    command - 起動コマンドライン
    
    context - 実行コンテキスト
  - error
```
@Published
protected void error(java.lang.Throwable error,
                                ExecutionContext context)
```
    実行時例外/エラーの発生によって本処理が終了した場合に一度だけ実行される。
    デフォルトでは何もしない。必要に応じてオーバライドすること。
    
    Parameters:
    
    error - 本処理で発生した実行時例外/エラー
    
    context - 実行コンテキスト
  - terminate
```
@Published
protected void terminate(Result result,
                                    ExecutionContext context)
```
    本処理が終了した場合に一度だけ実行される。（エラー終了した場合でも実行される。）
    デフォルトでは何もしない。必要に応じてオーバライドすること。
    
    Parameters:
    
    result - 本処理の実行結果
    
    context - 実行コンテキスト
  - transactionSuccess
```
@Published
protected void transactionSuccess(D inputData,
                                             ExecutionContext context)
```
    トランザクション処理が正常終了した場合に実行される。
    デフォルトでは何もしない。必要に応じてオーバライドすること。
    
    Parameters:
    
    inputData - 入力データ
    
    context - 実行コンテキスト
  - transactionFailure
```
@Published
protected void transactionFailure(D inputData,
                                             ExecutionContext context)
```
    トランザクション処理が異常終了した場合に実行される。
    デフォルトでは何もしない。必要に応じてオーバライドすること。
    
    Parameters:
    
    inputData - 入力データ
    
    context - 実行コンテキスト
  - writeLog
```
@Published
protected void writeLog(java.lang.String msgId,
                                   java.lang.Object... msgOptions)
```
    INFOレベルでログ出力を行う。
    
    Parameters:
    
    msgId - メッセージID
    
    msgOptions - メッセージIDから取得したメッセージに埋め込む値
  - writeErrorLog
```
@Published
protected void writeErrorLog(java.lang.Object data,
                                        java.lang.String failureCode,
                                        java.lang.Object... msgOptions)
```
    ERRORレベルで障害ログ出力を行う。
    障害ログは、障害通知ログと障害解析ログの２種類に分けて出力される。
    
    Parameters:
    
    data - 処理対象データ
    
    failureCode - 障害コード（メッセージID）
    
    msgOptions - 障害コードから取得したメッセージに埋め込む値
  - writeFatalLog
```
@Published
protected void writeFatalLog(java.lang.Object data,
                                        java.lang.String failureCode,
                                        java.lang.Object... msgOptions)
```
    FATALレベルで障害ログ出力を行う。
    障害ログは、障害通知ログと障害解析ログの２種類に分けて出力される。
    
    Parameters:
    
    data - 処理対象データ
    
    failureCode - 障害コード（メッセージID）
    
    msgOptions - 障害コードから取得したメッセージに埋め込む値
  - preExecution
```
@Published(tag="architect")
public final void preExecution(CommandLine commandLine,
                                                           ExecutionContext context)
```
    Description copied from interface: ExecutionHandlerCallback
    
    実行制御ハンドラが後続処理を実行する前にコールバックされる。一括処理実行前に、なんらかの初期処理を行う場合に実装する。
    
    Specified by:
    
    preExecution in interface ExecutionHandlerCallback<CommandLine,Result>
    
    Parameters:
    
    commandLine - 入力データ
    
    context - 実行コンテキスト
  - errorInExecution
```
@Published(tag="architect")
public final void errorInExecution(java.lang.Throwable error,
                                                               ExecutionContext context)
```
    Description copied from interface: ExecutionHandlerCallback
    
    実行制御ハンドラが後続処理を実行した後、後続のハンドラでエラーが発生した場合に呼ばれる。
    
    Specified by:
    
    errorInExecution in interface ExecutionHandlerCallback<CommandLine,Result>
    
    Parameters:
    
    error - 後続ハンドラの処理中に発生した実行時例外/エラー
    
    context - 実行コンテキスト
  - postExecution
```
@Published(tag="architect")
public final void postExecution(Result result,
                                                            ExecutionContext context)
```
    Description copied from interface: ExecutionHandlerCallback
    
    実行制御ハンドラが後続処理を実行した後、正常、異常終了を問わず処理が全て完了した直後に呼ばれる。すなわち、正常終了時には、の後、異常終了時には ExecutionHandlerCallback.errorInExecution(Throwable, ExecutionContext) の後で本メソッドが呼ばれる。
    
    Specified by:
    
    postExecution in interface ExecutionHandlerCallback<CommandLine,Result>
    
    Parameters:
    
    result - ハンドラの戻り値となるオブジェクト
    
    context - 実行コンテキスト
  - transactionNormalEnd
```
@Published(tag="architect")
public void transactionNormalEnd(D data,
                                                             ExecutionContext ctx)
```
  - transactionAbnormalEnd
```
@Published(tag="architect")
public void transactionAbnormalEnd(java.lang.Throwable e,
                                                               D data,
                                                               ExecutionContext ctx)
```

Class BatchActionBase<D>

Method Summary

Methods inherited from class nablarch.core.db.support.DbAccessSupport

Method Detail

initialize

error

terminate

transactionSuccess

transactionFailure

writeLog

writeErrorLog

writeFatalLog

preExecution

errorInExecution

postExecution

transactionNormalEnd

transactionAbnormalEnd