org.springframework.xd.dirt.rest

Class BatchStepExecutionsController

java.lang.Object

org.springframework.xd.dirt.rest.BatchStepExecutionsController

@Controller
@RequestMapping(value="/batch/executions/{jobExecutionId}/steps")
@ExposesResourceFor(value=StepExecutionInfoResource.class)
public class BatchStepExecutionsController
extends java.lang.Object

Controller for returning Batch StepExecutions.

Since:

1.0

Author:

Gunnar Hillert, Dave Syer, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
BatchStepExecutionsController(org.springframework.batch.admin.service.JobService jobService)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<StepExecutionInfoResource>	list(long jobExecutionId) List all step executions.
StepExecutionProgressInfoResource	progress(long jobExecutionId, long stepExecutionId) Get the step execution progress for the given jobExecutions step.
void	setTimeZone(java.util.TimeZone timeZone)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchStepExecutionsController

@Autowired
public BatchStepExecutionsController(org.springframework.batch.admin.service.JobService jobService)

Method Detail

setTimeZone

@Autowired(required=false)
@Qualifier(value="userTimeZone")
public void setTimeZone(java.util.TimeZone timeZone)

Parameters:

timeZone - the timeZone to set

list

@RequestMapping(value="",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public java.util.Collection<StepExecutionInfoResource> list(@PathVariable(value="jobExecutionId")
                                                                                              long jobExecutionId)

List all step executions.

Parameters:

jobExecutionId - Id of the JobExecution, must not be null

Returns:

Collection of StepExecutionInfoResource for the given jobExecutionId

Throws:

NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

progress

@RequestMapping(value="/{stepExecutionId}/progress",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public StepExecutionProgressInfoResource progress(@PathVariable
                                                                                    long jobExecutionId,
                                                                                    @PathVariable
                                                                                    long stepExecutionId)

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:

NoSuchJobExecutionException - Thrown if the respective JobExecution does not exist

NoSuchStepExecutionException - Thrown if the respective StepExecution does not exist