org.springframework.xd.dirt.rest

Class BatchJobExecutionsController

java.lang.Object

org.springframework.xd.dirt.rest.BatchJobExecutionsController

@Controller
@RequestMapping(value="/batch/executions")
@ExposesResourceFor(value=JobExecutionInfoResource.class)
public class BatchJobExecutionsController
extends java.lang.Object

Controller for batch job executions.

Author:

Dave Syer, Ilayaperumal Gopinathan, Gunnar Hillert

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
JobExecutionInfoResource	getJobExecutionInfo(java.lang.Long jobExecutionId)
java.util.Collection<JobExecutionInfoResource>	list(int startJobExecution, int pageSize) List all job executions in a given range.
void	setTimeZone(java.util.TimeZone timeZone)
void	stopAll() Stop all job executions.
void	stopJobExecution(java.lang.Long jobExecutionId) Stop Job Execution by the given executionId.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchJobExecutionsController

@Autowired
public BatchJobExecutionsController(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<JobExecutionInfoResource> list(@RequestParam(defaultValue="0")
                                                                                             int startJobExecution,
                                                                                             @RequestParam(defaultValue="20")
                                                                                             int pageSize)

List all job executions in a given range.

Parameters:

startJobExecution - index of the first job execution to get

pageSize - how many executions to return

Returns:

Collection of JobExecutionInfoResource

getJobExecutionInfo

@RequestMapping(value="/{jobExecutionId}",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public JobExecutionInfoResource getJobExecutionInfo(@PathVariable
                                                                                      java.lang.Long jobExecutionId)

Parameters:

jobExecutionId - Id of the JobExecution

Returns:

JobExecutionInfo for the given job name

Throws:

NoSuchJobExecutionException - Thrown if the JobExecution does not exist

stopJobExecution

@RequestMapping(value="/{executionId}",
                method=PUT,
                params="stop=true")
@ResponseStatus(value=OK)
public void stopJobExecution(@PathVariable(value="executionId")
                                                  java.lang.Long jobExecutionId)

Stop Job Execution by the given executionId.

Parameters:

jobExecutionId - the executionId of the job execution to stop

stopAll

@RequestMapping(value="",
                method=PUT,
                params="stop=true")
@ResponseStatus(value=OK)
public void stopAll()

Stop all job executions.