com.nec.webotx.batch.util
クラス BSForceStopDetectionListener

java.lang.Object
  上位を拡張 com.nec.webotx.batch.util.BSForceStopDetectionListener
すべての実装されたインタフェース:
StepExecutionListener, StepListener

public class BSForceStopDetectionListener
extends Object
implements StepExecutionListener

強制停止モードによる停止処理を有効にするためのリスナです。

強制停止モードによる停止要求の有無を任意のポイントで確認し、可能な限り即時にジョブを終了させたい場合、 下記のように各ステップの定義にこのリスナを設定した上で、停止要求確認ポイントに例のようなロジックを追加します。

 <b:step id="step">
     <b:tasklet>
         < ... settings... />
         <b:listeners>
             <b:listener ref="stopListener"/>
         </b:listeners>
     </b:tasklet>
 </b:step>
 
 <bean id="stopListener" class="com.nec.webotx.batch.util.BSForceStopDetectionListener" />
 
 <bean id="writer" class="some.user.package.ForceStopDetectionExample">
     <property name="forceStopDetectionListener" ref="stopListener"></property>
 </bean>
 
 public class ForceStopDetectionExample {
     private BSForceStopDetectionListener forceStopDetectionListener;
 
     ... accessor methods for forceStopDetectionListener ...
 
         :

     private void detectForceStop() {
         if (forceStopDetectionListener.checkForceStop()) {
             forceStopDetectionListener.triggerForceStop();
         }
     }
 }
 

導入されたバージョン:
WebOTX Batch Server V8.41.02.02
バージョン:
WebOTX Batch Server V8.42.01.00

コンストラクタの概要
BSForceStopDetectionListener()
           
 
メソッドの概要
 ExitStatus afterStep(StepExecution stepExecution)
          ステップの終了時に強制停止要求により終了したのかをチェックします。
 void beforeStep(StepExecution stepExecution)
          ステップの開始時にジョブのExecutionContextを取得します。
 boolean checkForceStop()
          ジョブのExecutionContextに強制停止フラグがセットされているか否かを確認します。
 void triggerForceStop()
          BSForceStopExceptionをthrowします。
 void triggerForceStop(String message)
          BSForceStopExceptionをthrowします。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

BSForceStopDetectionListener

public BSForceStopDetectionListener()
メソッドの詳細

afterStep

public ExitStatus afterStep(StepExecution stepExecution)
ステップの終了時に強制停止要求により終了したのかをチェックします。

定義:
インタフェース StepExecutionListener 内の afterStep
関連項目:
StepExecutionListener.afterStep(StepExecution)

beforeStep

public void beforeStep(StepExecution stepExecution)
ステップの開始時にジョブのExecutionContextを取得します。

定義:
インタフェース StepExecutionListener 内の beforeStep
関連項目:
StepExecutionListener.beforeStep(StepExecution)

checkForceStop

public boolean checkForceStop()
ジョブのExecutionContextに強制停止フラグがセットされているか否かを確認します。

戻り値:
強制停止フラグがセットされている場合はtrue

triggerForceStop

public void triggerForceStop()
                      throws com.nec.webotx.batch.core.execution.BSForceStopException
BSForceStopExceptionをthrowします。 ジョブを強制停止する場合に、呼び出します。

例外:
com.nec.webotx.batch.core.execution.BSForceStopException

triggerForceStop

public void triggerForceStop(String message)
                      throws com.nec.webotx.batch.core.execution.BSForceStopException
BSForceStopExceptionをthrowします。 ジョブを強制停止する場合に、呼び出します。

パラメータ:
message - 例外メッセージ
例外:
com.nec.webotx.batch.core.execution.BSForceStopException


Copyright © 2012 NEC Corporation. All Rights Reserved.