Package jakarta.batch.runtime.context

Interface JobContext

  • public interface JobContext
    A JobContext provides information about the current job execution.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      BatchStatus getBatchStatus()
      The getBatchStatus method simply returns the batch status value set by the batch runtime into the job context.
      long getExecutionId()
      The getExecutionId method returns the current job's current execution id.
      String getExitStatus()
      The getExitStatus method simply returns the exit status value stored into the job context through the setExitStatus method or null.
      long getInstanceId()
      The getInstanceId method returns the current job's instance id.
      String getJobName()
      Get job name
      Properties getProperties()
      The getProperties method returns the job level properties specified in a job definition.
      Object getTransientUserData()
      The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.
      void setExitStatus​(String status)
      The setExitStatus method assigns the user-specified exit status for the current job.
      void setTransientUserData​(Object data)
      The setTransientUserData method stores a transient data object into the current batch context.

    • Method Detail

      • getJobName

        String getJobName()
        Get job name
        Returns:
        value of 'id' attribute from <job>

      • getTransientUserData

        Object getTransientUserData()
        The getTransientUserData method returns a transient data object belonging to the current Job XML execution element.
        Returns:
        user-specified type

      • setTransientUserData

        void setTransientUserData​(Object data)
        The setTransientUserData method stores a transient data object into the current batch context.
        Parameters:
        data - is the user-specified type

      • getInstanceId

        long getInstanceId()
        The getInstanceId method returns the current job's instance id.
        Returns:
        job instance id

      • getExecutionId

        long getExecutionId()
        The getExecutionId method returns the current job's current execution id.
        Returns:
        job execution id

      • getProperties

        Properties getProperties()

        The getProperties method returns the job level properties specified in a job definition.

        A couple of notes:
        • There is no guarantee that the same Properties object instance is always returned in the same (job) scope.
        • Besides the properties which are defined in JSL within a child <properties> element of a <job> element, the batch runtime implementation may choose to include additional, implementation-defined properties.
        Returns:
        job level properties

      • getBatchStatus

        BatchStatus getBatchStatus()
        The getBatchStatus method simply returns the batch status value set by the batch runtime into the job context.
        Returns:
        batch status string

      • getExitStatus

        String getExitStatus()
        The getExitStatus method simply returns the exit status value stored into the job context through the setExitStatus method or null.
        Returns:
        exit status string

      • setExitStatus

        void setExitStatus​(String status)
        The setExitStatus method assigns the user-specified exit status for the current job. When the job ends, the exit status of the job is the value specified through setExitStatus. If setExitStatus was not called or was called with a null value, then the exit status defaults to the batch status of the job.
        Parameters:
        status - exit status string