nablarch.fw.handler

Class BasicProcessStopHandler

java.lang.Object

nablarch.fw.handler.BasicProcessStopHandler

All Implemented Interfaces:

Initializable, Handler<java.lang.Object,java.lang.Object>, ProcessStopHandler

public class BasicProcessStopHandler
extends java.lang.Object
implements ProcessStopHandler, Initializable

処理中のプロセスを停止するためのハンドラ。

本ハンドラは、LoopHandlerやProcessResidentHandlerの後続ハンドラに設定することにより、 処理中に安全にプロセスを停止することが可能となる。

なお、プロセスを停止するためにProcessStopを送出するため、障害通知ログが出力されプロセスは異常終了する。 異常終了する際に終了コードは、setExitCode(int)によって設定することが出来る。 終了コードの設定を省略した場合のデフォルト動作として終了コードは1となる。 また、未コミットのトランザクションは全てロールバックされることに注意すること。

※処理を異常終了するかどうかは、前段に設定されたハンドラによって決定される。

処理を停止するか否かのチェックは、リクエストテーブルにて行う。 本ハンドラが使用するリクエストテーブルの定義情報を下記に示す。

 -----------------------------+----------------------------------------------------------
 カラム名                     | 説明
 -----------------------------+----------------------------------------------------------
 リクエストID                 | プロセスを特定するためのリクエストID
 処理停止フラグ               | 処理を停止するか否かの情報
                              | 本フラグの値が'1'の場合に処理を停止する。
                              |
                              | 本フラグの値は、自動的に'0'には変更されないため再実行する際には、
                              | 手動で'0'に変更する必要がある。
 -----------------------------+----------------------------------------------------------
 

Nested Class Summary

Nested classes/interfaces inherited from interface nablarch.fw.handler.ProcessStopHandler

ProcessStopHandler.ProcessStop

Constructor Summary

Constructors

Constructor and Description
BasicProcessStopHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	handle(java.lang.Object o, ExecutionContext context) 入力データに対する処理を実行する。
void	initialize() 初期化処理を行う。
boolean	isProcessStop(java.lang.String requestId) プロセス停止可否を判定する。
void	setCheckInterval(int checkInterval) チェック間隔（handle(Object, ExecutionContext)が 何回呼び出されるごとに停止フラグを確認するか？）を設定する。
void	setDbTransactionManager(SimpleDbTransactionManager dbTransactionManager) トランザクションマネージャ(SimpleDbTransactionManager)を設定する。 本ハンドラは、ここで設定されたトランザクションマネージャを使用してデータベースアクセスを行う。
void	setExitCode(int exitCode) 終了コードを設定する。 終了コードの設定がない場合、デフォルトでResult.InternalError#STATUS_CODEが使用される。
void	setProcessHaltColumnName(java.lang.String processHaltColumnName) プロセス停止フラグが格納されるカラムの物理名を設定する。
void	setRequestIdColumnName(java.lang.String requestIdColumnName) プロセスを特定するためのリクエストIDが格納されるカラムの物理名を設定する。
void	setTableName(java.lang.String tableName) プロセス停止可否のチェックを行うテーブルの物理名を設定する。

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicProcessStopHandler

public BasicProcessStopHandler()

Method Detail

handle

public java.lang.Object handle(java.lang.Object o,
                               ExecutionContext context)

入力データに対する処理を実行する。

処理停止チェックを行う。

Specified by:

handle in interface Handler<java.lang.Object,java.lang.Object>

Parameters:

o - 入力データ

context - 実行コンテキスト

Returns:

処理結果データ

isProcessStop

public boolean isProcessStop(java.lang.String requestId)

プロセス停止可否を判定する。

Specified by:

isProcessStop in interface ProcessStopHandler

Parameters:

requestId - リクエストID

Returns:

プロセスを停止する必要がある場合はtrue

setCheckInterval

public void setCheckInterval(int checkInterval)

チェック間隔（handle(Object, ExecutionContext)が 何回呼び出されるごとに停止フラグを確認するか？）を設定する。

Specified by:

setCheckInterval in interface ProcessStopHandler

Parameters:

checkInterval - チェック間隔(0以下の値が設定された場合は1)

setDbTransactionManager

public void setDbTransactionManager(SimpleDbTransactionManager dbTransactionManager)

トランザクションマネージャ(SimpleDbTransactionManager)を設定する。

本ハンドラは、ここで設定されたトランザクションマネージャを使用してデータベースアクセスを行う。

Parameters:

dbTransactionManager - トランザクションマネージャ

initialize

public void initialize()

初期化処理を行う。

プロセス停止可否をチェックするためのSELECT文を構築する。

Specified by:

initialize in interface Initializable

setTableName

public void setTableName(java.lang.String tableName)

プロセス停止可否のチェックを行うテーブルの物理名を設定する。

Parameters:

tableName - テーブル物理名

setRequestIdColumnName

public void setRequestIdColumnName(java.lang.String requestIdColumnName)

プロセスを特定するためのリクエストIDが格納されるカラムの物理名を設定する。

Parameters:

requestIdColumnName - リクエストIDカラムの物理名

setProcessHaltColumnName

public void setProcessHaltColumnName(java.lang.String processHaltColumnName)

プロセス停止フラグが格納されるカラムの物理名を設定する。

Parameters:

processHaltColumnName - プロセス停止カラムフラグの物理名

setExitCode

public void setExitCode(int exitCode)

終了コードを設定する。

終了コードの設定がない場合、デフォルトでResult.InternalError#STATUS_CODEが使用される。

Specified by:

setExitCode in interface ProcessStopHandler

Parameters:

exitCode - 終了コード