org.springframework.batch.admin.web

Class BatchStepExecutionsController

java.lang.Object

org.springframework.batch.admin.web.AbstractBatchJobsController

org.springframework.batch.admin.web.BatchStepExecutionsController

@RestController
@RequestMapping(value="/batch/executions/{jobExecutionId}/steps")
@ExposesResourceFor(value=org.springframework.batch.admin.domain.StepExecutionInfoResource.class)
public class BatchStepExecutionsController
extends AbstractBatchJobsController

Controller for returning Batch StepExecutions.

Since:

2.0

Author:

Gunnar Hillert, Dave Syer, Ilayaperumal Gopinathan

Field Summary

Fields inherited from class org.springframework.batch.admin.web.AbstractBatchJobsController

jobExecutionInfoResourceAssembler, jobInfoResourceAssembler, jobInstanceInfoResourceAssembler, jobService, progressInfoResourceAssembler, stepExecutionInfoResourceAssembler, timeZone

Constructor Summary

Constructors

Constructor and Description
BatchStepExecutionsController()

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.batch.admin.domain.StepExecutionInfoResource	details(long jobExecutionId, long stepExecutionId) Inspect the StepExecution with the provided Step Execution Id
Collection<org.springframework.batch.admin.domain.StepExecutionInfoResource>	list(long jobExecutionId) List all step executions.
org.springframework.batch.admin.domain.StepExecutionProgressInfoResource	progress(long jobExecutionId, long stepExecutionId) Get the step execution progress for the given jobExecutions step.

Methods inherited from class org.springframework.batch.admin.web.AbstractBatchJobsController

setTimeZone

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BatchStepExecutionsController

public BatchStepExecutionsController()

Method Detail

list

@RequestMapping(value="",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public Collection<org.springframework.batch.admin.domain.StepExecutionInfoResource> list(@PathVariable(value="jobExecutionId")
                                                                                                              long jobExecutionId)
                                                                                  throws org.springframework.batch.core.launch.NoSuchJobExecutionException

List all step executions.

Parameters:

jobExecutionId - Id of the JobExecution, must not be null

Returns:

Collection of StepExecutionInfoResource for the given jobExecutionId

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

details

@RequestMapping(value="/{stepExecutionId}",
                method=GET)
@ResponseStatus(value=OK)
public org.springframework.batch.admin.domain.StepExecutionInfoResource details(@PathVariable
                                                                                                     long jobExecutionId,
                                                                                                     @PathVariable
                                                                                                     long stepExecutionId)
                                                                         throws NoSuchStepExecutionException,
                                                                                org.springframework.batch.core.launch.NoSuchJobExecutionException

Inspect the StepExecution with the provided Step Execution Id

Parameters:

jobExecutionId - Id of the JobExecution, must not be null

stepExecutionId - Id of the StepExecution, must not be null

Returns:

StepExecutionInfoResource that has the details on the given StepExecution.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

NoSuchStepExecutionException - Thrown if the respective StepExecution does not exist

progress

@RequestMapping(value="/{stepExecutionId}/progress",
                method=GET)
@ResponseStatus(value=OK)
public org.springframework.batch.admin.domain.StepExecutionProgressInfoResource progress(@PathVariable
                                                                                                              long jobExecutionId,
                                                                                                              @PathVariable
                                                                                                              long stepExecutionId)
                                                                                  throws NoSuchStepExecutionException,
                                                                                         org.springframework.batch.core.launch.NoSuchJobExecutionException

Get the step execution progress for the given jobExecutions step.

Parameters:

jobExecutionId - Id of the JobExecution, must not be null

stepExecutionId - Id of the StepExecution, must not be null

Returns:

StepExecutionInfoResource that has the progress info on the given StepExecution.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

NoSuchStepExecutionException - Thrown if the respective StepExecution does not exist