org.springframework.xd.dirt.rest

Class JobsController

java.lang.Object

org.springframework.xd.dirt.rest.XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource>

org.springframework.xd.dirt.rest.JobsController

@Controller
@RequestMapping(value="/jobs")
@ExposesResourceFor(value=JobDefinitionResource.class)
public class JobsController
extends XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource>

Handles all Job related interactions.

Since:

1.0

Author:

Glenn Renfro, Gunnar Hillert

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.xd.dirt.rest.XDController

XDController.QueryOptions

Constructor Summary

Constructors

Constructor and Description
JobsController(JobDeployer jobDeployer, JobDefinitionRepository jobDefinitionRepository)

Method Summary

Methods

Modifier and Type	Method and Description
protected JobDefinition	createDefinition(java.lang.String name, java.lang.String definition)
void	deploy(java.lang.String name) Request deployment of an existing named module.
void	deployJob(java.lang.String name, java.lang.String dateFormat, java.lang.String numberFormat, java.lang.Boolean makeUnique)
org.springframework.hateoas.PagedResources<JobDefinitionResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<JobDefinition> assembler) List job definitions.

Methods inherited from class org.springframework.xd.dirt.rest.XDController

delete, deleteAll, deployAll, display, getDeployer, listValues, save, undeploy, undeployAll

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsController

@Autowired
public JobsController(JobDeployer jobDeployer,
                        JobDefinitionRepository jobDefinitionRepository)

Method Detail

deploy

@RequestMapping(value="/unused/{name}",
                method=PUT,
                params="deploy=true")
@ResponseStatus(value=NOT_IMPLEMENTED)
@ResponseBody
public void deploy(java.lang.String name)

Description copied from class: XDController

Request deployment of an existing named module.

Overrides:

deploy in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource>

Parameters:

name - the name of an existing module (required)

deployJob

@RequestMapping(value="/{name}",
                method=PUT,
                params="deploy=true")
@ResponseStatus(value=OK)
@ResponseBody
public void deployJob(@PathVariable(value="name")
                                                        java.lang.String name,
                                                        @RequestParam(required=false)
                                                        java.lang.String dateFormat,
                                                        @RequestParam(required=false)
                                                        java.lang.String numberFormat,
                                                        @RequestParam(required=false)
                                                        java.lang.Boolean makeUnique)

list

@RequestMapping(value="",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.PagedResources<JobDefinitionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                org.springframework.data.web.PagedResourcesAssembler<JobDefinition> assembler)

List job definitions.

createDefinition

protected JobDefinition createDefinition(java.lang.String name,
                             java.lang.String definition)

Specified by:

createDefinition in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource>