Class JobExecution

Constructor Detail

• JobExecution

  public JobExecution​(JobExecution original)

• JobExecution

  public JobExecution​(JobInstance job,
                      java.lang.Long id,
                      @Nullable
                      JobParameters jobParameters,
                      java.lang.String jobConfigurationName)

  Because a JobExecution isn't valid unless the job is set, this constructor is the only valid one from a modeling point of view.

  Parameters:

  job - the job of which this execution is a part

  id - Long that represents the id for the JobExecution.

  jobParameters - JobParameters instance for this JobExecution.

  jobConfigurationName - String instance that represents the job configuration name (used with JSR-352).

• JobExecution

  public JobExecution​(JobInstance job,
                      JobParameters jobParameters,
                      java.lang.String jobConfigurationName)

• JobExecution

  public JobExecution​(java.lang.Long id,
                      JobParameters jobParameters,
                      java.lang.String jobConfigurationName)

• JobExecution

  public JobExecution​(JobInstance job,
                      JobParameters jobParameters)

  Constructor for transient (unsaved) instances.

  Parameters:

  job - the enclosing JobInstance

  jobParameters - JobParameters instance for this JobExecution.

• JobExecution

  public JobExecution​(java.lang.Long id,
                      JobParameters jobParameters)

• JobExecution

  public JobExecution​(java.lang.Long id)

Method Detail

• getJobParameters

  public JobParameters getJobParameters()

• getEndTime

  public java.util.Date getEndTime()

• setJobInstance

  public void setJobInstance​(JobInstance jobInstance)

• setEndTime

  public void setEndTime​(java.util.Date endTime)

• getStartTime

  public java.util.Date getStartTime()

• setStartTime

  public void setStartTime​(java.util.Date startTime)

• getStatus

  public BatchStatus getStatus()

• setStatus

  public void setStatus​(BatchStatus status)

  Set the value of the status field.

  Parameters:

  status - the status to set

• upgradeStatus

  public void upgradeStatus​(BatchStatus status)

  Upgrade the status field if the provided value is greater than the existing one. Clients using this method to set the status can be sure that they don't overwrite a failed status with an successful one.

  Parameters:

  status - the new status value

• getJobId

  public java.lang.Long getJobId()

  Convenience getter for for the id of the enclosing job. Useful for DAO implementations.

  Returns:

  the id of the enclosing job

• setExitStatus

  public void setExitStatus​(ExitStatus exitStatus)

  Parameters:

  exitStatus - ExitStatus instance to be used for job execution.

• getExitStatus

  public ExitStatus getExitStatus()

  Returns:

  the exitCode

• getJobInstance

  public JobInstance getJobInstance()

  Returns:

  the Job that is executing.

• getStepExecutions

  public java.util.Collection<StepExecution> getStepExecutions()

  Accessor for the step executions.

  Returns:

  the step executions that were registered

• createStepExecution

  public StepExecution createStepExecution​(java.lang.String stepName)

  Register a step execution with the current job execution.

  Parameters:

  stepName - the name of the step the new execution is associated with

  Returns:

  StepExecution an empty StepExecution associated with this JobExecution.

• isRunning

  public boolean isRunning()

  Test if this JobExecution indicates that it is running. It should be noted that this does not necessarily mean that it has been persisted as such yet.

  Returns:

  true if the end time is null and the start time is not null

• isStopping

  public boolean isStopping()

  Test if this JobExecution indicates that it has been signalled to stop.

  Returns:

  true if the status is BatchStatus.STOPPING

• stop

  public void stop()

  Signal the JobExecution to stop. Iterates through the associated StepExecutions, calling StepExecution.setTerminateOnly().

• setExecutionContext

  public void setExecutionContext​(ExecutionContext executionContext)

  Sets the ExecutionContext for this execution

  Parameters:

  executionContext - the context

• getExecutionContext

  public ExecutionContext getExecutionContext()

  Returns the ExecutionContext for this execution. The content is expected to be persisted after each step completion (successful or not).

  Returns:

  the context

• getCreateTime

  public java.util.Date getCreateTime()

  Returns:

  the time when this execution was created.

• setCreateTime

  public void setCreateTime​(java.util.Date createTime)

  Parameters:

  createTime - creation time of this execution.

• getJobConfigurationName

  public java.lang.String getJobConfigurationName()

• getLastUpdated

  public java.util.Date getLastUpdated()

  Get the date representing the last time this JobExecution was updated in the JobRepository.

  Returns:

  Date representing the last time this JobExecution was updated.

• setLastUpdated

  public void setLastUpdated​(java.util.Date lastUpdated)

  Set the last time this JobExecution was updated.

  Parameters:

  lastUpdated - Date instance to mark job execution's lastUpdated attribute.

• getFailureExceptions

  public java.util.List<java.lang.Throwable> getFailureExceptions()

• addFailureException

  public void addFailureException​(java.lang.Throwable t)

  Add the provided throwable to the failure exception list.

  Parameters:

  t - Throwable instance to be added failure exception list.

• getAllFailureExceptions

  public java.util.List<java.lang.Throwable> getAllFailureExceptions()

  Return all failure causing exceptions for this JobExecution, including step executions.

  Returns:

  List<Throwable> containing all exceptions causing failure for this JobExecution.

• toString

  public java.lang.String toString()

  Overrides:

  toString in class Entity

• addStepExecutions

  public void addStepExecutions​(java.util.List<StepExecution> stepExecutions)

  Add some step executions. For internal use only.

  Parameters:

  stepExecutions - step executions to add to the current list