org.springframework.cloud.dataflow.server.controller

Class JobExecutionController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.JobExecutionController

@RestController
@RequestMapping(value="/jobs/executions")
@ExposesResourceFor(value=JobExecutionResource.class)
public class JobExecutionController
extends Object

Controller for operations on JobExecution. This includes obtaining Job execution information from the job explorer.

Author:

Glenn Renfro, Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
JobExecutionController(TaskJobService taskJobService) Creates a JobExecutionController that retrieves Job Execution information from a the JobService

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.hateoas.PagedResources<JobExecutionResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler) Return a page-able list of JobExecutionResource defined jobs.
void	restartJobExecution(long jobExecutionId) Restart the Job Execution with the given jobExecutionId.
org.springframework.hateoas.PagedResources<JobExecutionResource>	retrieveJobsByName(String jobName, org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler) Retrieve all task job executions with the task name specified
void	stopJobExecution(long jobExecutionId) Stop a Job Execution with the given jobExecutionId.
JobExecutionResource	view(long id) View the details of a single task execution, specified by id.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobExecutionController

@Autowired
public JobExecutionController(TaskJobService taskJobService)

Creates a JobExecutionController that retrieves Job Execution information from a the JobService

Parameters:

taskJobService - the service this controller will use for retrieving job execution information. Must not be null.

Method Detail

list

@RequestMapping(value="",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<JobExecutionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                               org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler)
                                                                      throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Return a page-able list of JobExecutionResource defined jobs.

Parameters:

pageable - page-able collection of TaskJobExecutions.

assembler - for the TaskJobExecutions

Returns:

a list of Task/Job executions

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

retrieveJobsByName

@RequestMapping(value="",
                method=GET,
                params="name",
                produces="application/json")
@ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<JobExecutionResource> retrieveJobsByName(@RequestParam(value="name")
                                                                                                                                                   String jobName,
                                                                                                                                                   org.springframework.data.domain.Pageable pageable,
                                                                                                                                                   org.springframework.data.web.PagedResourcesAssembler<TaskJobExecution> assembler)
                                                                                    throws org.springframework.batch.core.launch.NoSuchJobException

Retrieve all task job executions with the task name specified

Parameters:

jobName - name of the job

pageable - page-able collection of TaskJobExecutions.

assembler - for the TaskJobExecutions

Throws:

org.springframework.batch.core.launch.NoSuchJobException

view

@RequestMapping(value="/{id}",
                method=GET,
                produces="application/json")
@ResponseStatus(value=OK)
public JobExecutionResource view(@PathVariable(value="id")
                                                                                   long id)
                          throws org.springframework.batch.core.launch.NoSuchJobExecutionException

View the details of a single task execution, specified by id.

Parameters:

id - the id of the requested JobExecution

Returns:

the JobExecution

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException

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.NoSuchJobExecutionException,
                             org.springframework.batch.core.launch.JobExecutionNotRunningException

Stop a Job Execution with the given jobExecutionId. Please be aware that you must provide the request parameter stop=true in order to invoke this endpoint.

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

Restart the Job Execution with the given jobExecutionId. Please be aware that you must provide the request parameter restart=true in order to invoke this endpoint.

Parameters:

jobExecutionId - the executionId of the job execution to restart

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException