インターフェース StepContext


  • public interface StepContext
    StepContext は、ジョブ実行の現在のステップに関する情報を提供します。
    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      BatchStatusgetBatchStatus()
      getBatchStatus メソッドは、現在のステップの現在のバッチステータスを返します。
      ExceptionSEgetException()
      getException メソッドは、ステップレベルのバッチアーティファクトからバッチランタイムにスローされた最後の例外を返します。
      StringSEgetExitStatus()
      getExitStatus メソッドは、setExitStatus メソッドを通じてステップコンテキストに格納された終了ステータス値または null を返すだけです。
      Metric[]getMetrics()
      getMetrics メソッドは、ステップレベルのメトリクスの配列を返します。
      SerializableSEgetPersistentUserData()
      getPersistentUserData メソッドは、現在のステップに属する永続データオブジェクトを返します。
      PropertiesSEgetProperties()
      getProperties メソッドは、ジョブ定義で指定されたステップレベルのプロパティを返します。
      longgetStepExecutionId()
      getStepExecutionId メソッドは、現在のステップの実行 ID を返します。
      StringSEgetStepName()
      ステップ名を取得します。
      ObjectSEgetTransientUserData()
      getTransientUserData メソッドは、現在のジョブ XML 実行要素に属する一時データオブジェクトを返します。
      voidsetExitStatus​(StringSE status)
      setExitStatus メソッドは、現在のステップにユーザー指定の終了ステータスを割り当てます。
      voidsetPersistentUserData​(SerializableSE data)
      setPersistentUserData メソッドは、永続的なデータオブジェクトを現在のステップに保存します。
      voidsetTransientUserData​(ObjectSE data)
      setTransientUserData メソッドは、一時的なデータオブジェクトを現在のバッチコンテキストに格納します。
    • メソッドの詳細

      • getStepName

        StringSE getStepName()
        ステップ名を取得します。
        戻り値:
        <step> からの 'id' 属性の値
      • getTransientUserData

        ObjectSE getTransientUserData()
        getTransientUserData メソッドは、現在のジョブ XML 実行要素に属する一時データオブジェクトを返します。
        戻り値:
        ユーザー指定の型
      • setTransientUserData

        void setTransientUserData​(ObjectSE data)
        setTransientUserData メソッドは、一時的なデータオブジェクトを現在のバッチコンテキストに格納します。
        パラメーター:
        data - ユーザー指定の型です
      • getStepExecutionId

        long getStepExecutionId()
        getStepExecutionId メソッドは、現在のステップの実行 ID を返します。
        戻り値:
        ステップ実行 ID
      • getProperties

        PropertiesSE getProperties()

        getProperties メソッドは、ジョブ定義で指定されたステップレベルのプロパティを返します。

        いくつかのメモ:
        • 同じ Properties オブジェクトインスタンスが常に同じ(ステップ)スコープで返されるという保証はありません。
        • <step> 要素の子 <properties> 要素内の JSL で定義されているプロパティに加えて、バッチランタイム実装は、追加の実装定義プロパティを含めることを選択できます。
        戻り値:
        ステップレベルのプロパティ
      • getPersistentUserData

        SerializableSE getPersistentUserData()
        getPersistentUserData メソッドは、現在のステップに属する永続データオブジェクトを返します。ユーザーデータ型は、java.util.Serializable を実装する必要があります。このデータは、ステップのチェックポイントの一部として保存されます。チェックポイントを実行しないステップの場合、データはステップの終了後に保存されます。再起動すると使用可能になります。
        戻り値:
        ユーザー指定の型
      • setPersistentUserData

        void setPersistentUserData​(SerializableSE data)
        setPersistentUserData メソッドは、現在のステップに永続的なデータオブジェクトを保存します。ユーザーデータ型は、java.util.Serializable を実装する必要があります。このデータは、ステップのチェックポイントの一部として保存されます。チェックポイントを実行しないステップの場合、データはステップの終了後に保存されます。再起動すると使用可能になります。
        パラメーター:
        data - ユーザー指定の型です
      • getBatchStatus

        BatchStatus getBatchStatus()
        getBatchStatus メソッドは、現在のステップの現在のバッチステータスを返します。この値はバッチランタイムによって設定され、バッチステータスが変化すると変化します。
        戻り値:
        バッチステータス文字列
      • getExitStatus

        StringSE getExitStatus()
        getExitStatus メソッドは、setExitStatus メソッドを通じてステップコンテキストに格納された終了ステータス値または null を返すだけです。
        戻り値:
        終了ステータス文字列
      • setExitStatus

        void setExitStatus​(StringSE status)
        setExitStatus メソッドは、現在のステップにユーザー指定の終了ステータスを割り当てます。ステップが終了すると、ステップの終了ステータスは setExitStatus で指定された値になります。setExitStatus が呼び出されなかったか、null 値で呼び出された場合、終了ステータスはデフォルトでステップのバッチステータスになります。
        パラメーター:
        status - 文字列
      • getException

        ExceptionSE getException()
        getException メソッドは、ステップレベルのバッチアーティファクトからバッチランタイムにスローされた最後の例外を返します。
        戻り値:
        最後の例外
      • getMetrics

        Metric[] getMetrics()
        getMetrics メソッドは、ステップレベルのメトリクスの配列を返します。これらは、コミット、スキップなどのものです。
        戻り値:
        メトリクス配列
        関連事項:
        for definition of standard metrics.