org.springframework.batch.admin.web

Class BatchJobExecutionsController

java.lang.Object

org.springframework.batch.admin.web.AbstractBatchJobsController

org.springframework.batch.admin.web.BatchJobExecutionsController

@RestController
@RequestMapping(value="/batch/executions")
@ExposesResourceFor(value=org.springframework.batch.admin.domain.JobExecutionInfoResource.class)
public class BatchJobExecutionsController
extends AbstractBatchJobsController

Controller for batch job executions.

Since:

2.0

Author:

Dave Syer, Ilayaperumal Gopinathan, Gunnar Hillert

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
BatchJobExecutionsController()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<org.springframework.batch.admin.domain.JobExecutionInfoResource>	executionsForJob(String jobName, int startJobExecution, int pageSize) Return a paged collection of job executions for a given job.
org.springframework.batch.admin.domain.JobExecutionInfoResource	getJobExecutionInfo(long executionId)
void	launchJob(String name, String jobParameters) Send the request to launch Job.
org.springframework.hateoas.PagedResources<org.springframework.batch.admin.domain.JobExecutionInfoResource>	list(org.springframework.data.domain.Pageable pageable) List all job executions in a given range.
void	restartJobExecution(long jobExecutionId) Restart the Job Execution with the given executionId.
void	stopAll() Stop all job executions.
void	stopJobExecution(long jobExecutionId) Stop Job Execution by the given executionId.

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

BatchJobExecutionsController

public BatchJobExecutionsController()

Method Detail

list

@RequestMapping(value="",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<org.springframework.batch.admin.domain.JobExecutionInfoResource> list(org.springframework.data.domain.Pageable pageable)
                                                                                                                 throws org.springframework.batch.core.launch.NoSuchJobException

List all job executions in a given range. If no pagination is provided, the default PageRequest(0, 20) is passed in. See PageableHandlerMethodArgumentResolver for details.

Parameters:

pageable - If not provided will default to page 0 and a page size of 20

Returns:

Collection of JobExecutionInfoResource

Throws:

org.springframework.batch.core.launch.NoSuchJobException

executionsForJob

@RequestMapping(value="",
                method=GET,
                params="jobname",
                produces="application/json")
@ResponseStatus(value=OK)
public Collection<org.springframework.batch.admin.domain.JobExecutionInfoResource> executionsForJob(@RequestParam(value="jobname")
                                                                                                                         String jobName,
                                                                                                                         @RequestParam(defaultValue="0")
                                                                                                                         int startJobExecution,
                                                                                                                         @RequestParam(defaultValue="20")
                                                                                                                         int pageSize)

Return a paged collection of job executions for a given job.

Parameters:

jobName - name of the job

startJobExecution - start index for the job execution list

pageSize - page size for the list

Returns:

collection of JobExecutionInfo

launchJob

@RequestMapping(value="",
                method=POST,
                params="jobname")
@ResponseStatus(value=CREATED)
public void launchJob(@RequestParam(value="jobname")
                                           String name,
                                           @RequestParam(required=false)
                                           String jobParameters)
               throws org.springframework.batch.core.JobParametersInvalidException,
                      org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
                      org.springframework.batch.core.repository.JobRestartException,
                      org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException,
                      org.springframework.batch.core.launch.NoSuchJobException

Send the request to launch Job. Job has to be deployed first.

Parameters:

name - the name of the job

jobParameters - the job parameters in comma delimited form

Throws:

org.springframework.batch.core.JobParametersInvalidException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.launch.NoSuchJobException

getJobExecutionInfo

@RequestMapping(value="/{executionId}",
                method=GET)
@ResponseStatus(value=OK)
public org.springframework.batch.admin.domain.JobExecutionInfoResource getJobExecutionInfo(@PathVariable
                                                                                                                long executionId)
                                                                                    throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Parameters:

executionId - Id of the JobExecution

Returns:

JobExecutionInfo for the given job name

Throws:

org.springframework.batch.core.launch.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")
                                                  long jobExecutionId)
                      throws org.springframework.batch.core.launch.JobExecutionNotRunningException,
                             org.springframework.batch.core.launch.NoSuchJobExecutionException

Stop Job Execution by the given executionId.

Parameters:

jobExecutionId - the executionId of the job execution to stop

Throws:

org.springframework.batch.core.launch.JobExecutionNotRunningException

org.springframework.batch.core.launch.NoSuchJobExecutionException

restartJobExecution

@RequestMapping(value="/{executionId}",
                method=PUT,
                params="restart=true")
@ResponseStatus(value=OK)
public void restartJobExecution(@PathVariable(value="executionId")
                                                     long jobExecutionId)
                         throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                                org.springframework.batch.core.repository.JobExecutionAlreadyRunningException,
                                org.springframework.batch.core.JobParametersInvalidException,
                                org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException,
                                org.springframework.batch.core.repository.JobRestartException,
                                org.springframework.batch.core.launch.NoSuchJobException

Restart the Job Execution with the given executionId.

Parameters:

jobExecutionId - the executionId of the job execution to restart

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

org.springframework.batch.core.repository.JobExecutionAlreadyRunningException

org.springframework.batch.core.JobParametersInvalidException

org.springframework.batch.core.repository.JobInstanceAlreadyCompleteException

org.springframework.batch.core.repository.JobRestartException

org.springframework.batch.core.launch.NoSuchJobException

stopAll

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

Stop all job executions.