org.springframework.batch.admin.web

Class BatchJobInstancesController

java.lang.Object

org.springframework.batch.admin.web.AbstractBatchJobsController

org.springframework.batch.admin.web.BatchJobInstancesController

@RestController
@RequestMapping(value="/batch/instances")
@ExposesResourceFor(value=JobInstanceInfoResource.class)
public class BatchJobInstancesController
extends AbstractBatchJobsController

Controller for batch job instances.

Since:

2.0

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
JobInstanceInfoResource	getJobInstance(long instanceId) Return job instance info by the given instance id.
Collection<JobInstanceInfoResource>	instancesForJob(String jobName, int startJobInstance, int pageSize) Return a paged collection of job instances for a given job.

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

BatchJobInstancesController

public BatchJobInstancesController()

Method Detail

getJobInstance

@RequestMapping(value="/{instanceId}",
                method=GET)
@ResponseStatus(value=OK)
public JobInstanceInfoResource getJobInstance(@PathVariable
                                                                                        long instanceId)

Return job instance info by the given instance id.

Parameters:

instanceId - job instance id

Returns:

job instance info

instancesForJob

@RequestMapping(value="",
                method=GET,
                params="jobname")
@ResponseStatus(value=OK)
public Collection<JobInstanceInfoResource> instancesForJob(@RequestParam(value="jobname")
                                                                                                           String jobName,
                                                                                                           @RequestParam(defaultValue="0")
                                                                                                           int startJobInstance,
                                                                                                           @RequestParam(defaultValue="20")
                                                                                                           int pageSize)

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

Parameters:

jobName - name of the batch job

startJobInstance - start index for the job instance

pageSize - page size for the list

Returns:

collection of JobInstances by job name