org.springframework.batch.admin.web

Class BatchJobsController

java.lang.Object

org.springframework.batch.admin.web.AbstractBatchJobsController

org.springframework.batch.admin.web.BatchJobsController

@RestController
@RequestMapping(value="/batch/configurations")
@ExposesResourceFor(value=org.springframework.batch.admin.domain.DetailedJobInfoResource.class)
public class BatchJobsController
extends AbstractBatchJobsController

Controller for batch jobs and job instances, job executions on a given batch job.

Since:

2.0

Author:

Dave Syer, Ilayaperumal Gopinathan, Andrew Eisenberg

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

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.batch.admin.domain.DetailedJobInfoResource	jobinfo(String jobName)
org.springframework.hateoas.PagedResources<org.springframework.batch.admin.domain.DetailedJobInfoResource>	jobs(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<org.springframework.batch.admin.domain.DetailedJobInfo> assembler) Get the paged resources of DetailedJobInfoResource

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

BatchJobsController

public BatchJobsController()

Method Detail

jobs

@RequestMapping(value="",
                method=GET)
@ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<org.springframework.batch.admin.domain.DetailedJobInfoResource> jobs(org.springframework.data.domain.Pageable pageable,
                                                                                                                                            org.springframework.data.web.PagedResourcesAssembler<org.springframework.batch.admin.domain.DetailedJobInfo> assembler)

Get the paged resources of DetailedJobInfoResource

Parameters:

pageable - the paging metadata

assembler - the paged resource assembler of type DetailedJobInfo

jobinfo

@RequestMapping(value="/{jobName}",
                method=GET)
@ResponseStatus(value=OK)
public org.springframework.batch.admin.domain.DetailedJobInfoResource jobinfo(@PathVariable
                                                                                                   String jobName)

Parameters:

jobName - name of the job

Returns:

ExpandedJobInfo for the given job name