パッケージ org.springframework.batch.core.listener

クラス ExecutionContextPromotionListener

java.lang.ObjectSE
org.springframework.batch.core.listener.ExecutionContextPromotionListener
実装されたすべてのインターフェース:
StepExecutionListener、StepListener、org.springframework.beans.factory.InitializingBean
public class ExecutionContextPromotionListener extends ObjectSE implements StepExecutionListener, org.springframework.beans.factory.InitializingBean
このクラスを使用すると、ステップの終了時に項目を Step ExecutionContext から Job ExecutionContext に自動的に昇格させることができます。昇格する必要がある Step ExecutionContext の項目に対応するキーのリストを提供する必要があります。

さらに、ステータスのオプションのリストを設定して、どの終了ステータスコードに対してプロモーションが発生するかを示すことができます。これらのステータスは PatternMatcher を使用してチェックされるため、ワイルドカードが許可されます。デフォルトでは、昇格は終了コードが "COMPLETED" のステップに対してのみ発生します。

導入:
2.0
作成者:
Dan Garrette, Mahmoud Ben Hassine

  • コンストラクターの詳細

    • ExecutionContextPromotionListener

      public ExecutionContextPromotionListener()

  • メソッドの詳細

    • afterStep

      @Nullable public ExitStatus afterStep(StepExecution stepExecution)
      インターフェースからコピーされた説明: StepExecutionListener
      リスナーにステップの終了ステータスを変更する機会を与えます。返された値は、ExitStatus.and(ExitStatus) を使用して通常の終了ステータスと結合されます。

      ステップの処理ロジックの実行後に (成功または失敗に関係なく) 呼び出されます。このメソッドで例外をスローしても、ログに記録されるだけなので効果はありません。

      次で指定:
      インターフェース StepExecutionListener の afterStep 
      パラメーター:
      stepExecution - StepExecution インスタンス。
      戻り値:
      通常の値と組み合わせる ExitStatus。古い値を変更しない場合は、null (デフォルト) を返します。

    • afterPropertiesSet

      public void afterPropertiesSet() throws ExceptionSE
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      例外:
      ExceptionSE

    • setKeys

      public void setKeys(StringSE[] keys)
      パラメーター:
      keys - 昇格する必要がある Step ExecutionContext のアイテムに対応するキーのリスト。

    • setStatuses

      public void setStatuses(StringSE[] statuses)
      パラメーター:
      statuses - 昇格が発生するステータスのリスト。ステータスには、PatternMatcher で認識可能なワイルドカードを含めることができます。

    • setStrict

      public void setStrict(boolean strict)
      TRUE に設定すると、ステップ ExecutionContext で「キー」が見つからない場合、リスナーは例外をスローします。デフォルトでは FALSE です。
      パラメーター:
      strict - フラグの値をブール値。