org.springframework.xd.dirt.rest

Class ModulesController

java.lang.Object

org.springframework.xd.dirt.rest.ModulesController

@Controller
@RequestMapping(value="/modules")
@ExposesResourceFor(value=ModuleDefinitionResource.class)
public class ModulesController
extends java.lang.Object

Handles all Module related interactions.

Author:

Glenn Renfro, Mark Fisher, Gunnar Hillert, Eric Bottard

Constructor Summary

Constructors

Constructor and Description
ModulesController(CompositeModuleDefinitionService compositeModuleDefinitionService, DetailedModuleDefinitionResourceAssembler detailedAssembler)

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(ModuleType type, java.lang.String name) Delete a (composite) module.
org.springframework.core.io.Resource	downloadDefinition(ModuleType type, java.lang.String name) Retrieve the configuration file for the provided module information.
DetailedModuleDefinitionResource	info(ModuleType type, java.lang.String name) Retrieve detailed module definition about a particular module.
org.springframework.hateoas.PagedResources<ModuleDefinitionResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<ModuleDefinition> assembler, ModuleType type) List Module definitions.
ModuleDefinitionResource	save(java.lang.String name, java.lang.String definition) Create a new composite Module.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulesController

@Autowired
public ModulesController(CompositeModuleDefinitionService compositeModuleDefinitionService,
                           DetailedModuleDefinitionResourceAssembler detailedAssembler)

Method Detail

list

@RequestMapping(value="",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.PagedResources<ModuleDefinitionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                   org.springframework.data.web.PagedResourcesAssembler<ModuleDefinition> assembler,
                                                                                                                   @RequestParam(value="type",required=false)
                                                                                                                   ModuleType type)

List Module definitions.

info

@RequestMapping(value="/{type}/{name}",
                method=GET)
@ResponseStatus(value=OK)
@ResponseBody
public DetailedModuleDefinitionResource info(@PathVariable(value="type")
                                                                               ModuleType type,
                                                                               @PathVariable(value="name")
                                                                               java.lang.String name)

Retrieve detailed module definition about a particular module.

save

@RequestMapping(value="",
                method=POST)
@ResponseStatus(value=CREATED)
@ResponseBody
public ModuleDefinitionResource save(@RequestParam(value="name")
                                                                       java.lang.String name,
                                                                       @RequestParam(value="definition")
                                                                       java.lang.String definition)

Create a new composite Module.

Parameters:

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

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

delete

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

Delete a (composite) module.

downloadDefinition

@RequestMapping(value="/{type}/{name}/definition",
                method=GET,
                produces="application/xml")
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.core.io.Resource downloadDefinition(@PathVariable(value="type")
                                                                                                 ModuleType type,
                                                                                                 @PathVariable(value="name")
                                                                                                 java.lang.String name)

Retrieve the configuration file for the provided module information.

Parameters:

name - the name of an existing resource (required)

type - the type of the module (required)