org.springframework.xd.dirt.rest

Class JobsController

java.lang.Object

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

org.springframework.xd.dirt.rest.JobsController

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

Handles all Job related interactions.

Author:

Glenn Renfro, Gunnar Hillert, Ilayaperumal Gopinathan, David Turanski

Nested Class Summary

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

XDController.QueryOptions

Field Summary

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

deployer

Constructor Summary

Constructors

Constructor and Description
JobsController(JobDeployer jobDeployer, ModuleDefinitionService moduleDefinitionService)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	clean(java.lang.String job, java.lang.String adminUri, java.lang.String user, java.lang.String pw, java.lang.String vhost, java.lang.String busPrefix)
protected JobDefinition	createDefinition(java.lang.String name, java.lang.String definition)
void	delete(java.lang.String name) Request removal of an existing resource definition (stream or job).
void	deleteAll() Request removal of all definitions.
org.springframework.hateoas.PagedResources<JobDefinitionResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<JobDefinition> assembler) List job definitions.
void	save(java.lang.String name, java.lang.String definition, boolean deploy) Create a new resource definition.

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

cleanRabbitBus, deploy, display, listValues, 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,
                        ModuleDefinitionService moduleDefinitionService)

Method Detail

save

@RequestMapping(value="/definitions",
                method=POST)
@ResponseStatus(value=CREATED)
public void save(@RequestParam(value="name")
                                      java.lang.String name,
                                      @RequestParam(value="definition")
                                      java.lang.String definition,
                                      @RequestParam(value="deploy",defaultValue="true")
                                      boolean deploy)
          throws java.lang.Exception

Description copied from class: XDController

Create a new resource definition.

Overrides:

save in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource,Job>

Parameters:

name - The name of the entity to create (required)

definition - The entity definition, expressed in the XD DSL (required)

Throws:

java.lang.Exception

delete

@RequestMapping(value="/definitions/{name}",
                method=DELETE)
@ResponseStatus(value=OK)
public void delete(@PathVariable(value="name")
                                        java.lang.String name)
            throws java.lang.Exception

Request removal of an existing resource definition (stream or job).

Overrides:

delete in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource,Job>

Parameters:

name - the name of an existing definition (required)

Throws:

java.lang.Exception

deleteAll

@RequestMapping(value="/definitions",
                method=DELETE)
@ResponseStatus(value=OK)
public void deleteAll()
               throws java.lang.Exception

Request removal of all definitions.

Overrides:

deleteAll in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource,Job>

Throws:

java.lang.Exception

list

@RequestMapping(value="/definitions",
                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.

clean

@ResponseBody
@RequestMapping(value="/clean/rabbit/{job}",
                method=DELETE)
@ResponseStatus(value=OK)
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> clean(@PathVariable
                                                                                                                java.lang.String job,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String adminUri,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String user,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String pw,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String vhost,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String busPrefix)

createDefinition

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

Specified by:

createDefinition in class XDController<JobDefinition,JobDefinitionResourceAssembler,JobDefinitionResource,Job>