org.springframework.xd.dirt.rest

Class ModulesMetadataController

java.lang.Object

org.springframework.xd.dirt.rest.ModulesMetadataController

@Controller
@RequestMapping(value="/runtime/modules")
@ExposesResourceFor(value=ModuleMetadataResource.class)
public class ModulesMetadataController
extends java.lang.Object

Controller that handles the interaction with the deployed modules.

Author:

Ilayaperumal Gopinathan, Gunnar Hillert

Constructor Summary

Constructors

Constructor and Description
ModulesMetadataController(ModuleMetadataRepository moduleMetadataRepository)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ModuleMetadataResource>	displayForJobname(java.lang.String jobName) Will return a collection of ModuleMetadata that are associated with the provided jobname request parameter.
org.springframework.hateoas.PagedResources<ModuleMetadataResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<ModuleMetadata> assembler) List module metadata for all the deployed modules.
org.springframework.hateoas.PagedResources<ModuleMetadataResource>	listByContainer(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<ModuleMetadata> assembler, java.lang.String containerId) List the module metadata for all the modules that are deployed to the given container.
ModuleMetadataResource	listByContainerAndModuleId(java.lang.String containerId, java.lang.String moduleId) List the module metadata for the given moduleId and deployed to the given containerId.
org.springframework.hateoas.PagedResources<ModuleMetadataResource>	listByModule(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<ModuleMetadata> assembler, java.lang.String moduleId) List the module metadata for all the modules with the given moduleId.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModulesMetadataController

@Autowired
public ModulesMetadataController(ModuleMetadataRepository moduleMetadataRepository)

Method Detail

list

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

List module metadata for all the deployed modules.

Parameters:

pageable - pagination information

assembler - paged resource assembler

Returns:

paged ModuleMetadataResource

listByContainer

@RequestMapping(value="",
                method=GET,
                params="containerId")
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.PagedResources<ModuleMetadataResource> listByContainer(org.springframework.data.domain.Pageable pageable,
                                                                                                                            org.springframework.data.web.PagedResourcesAssembler<ModuleMetadata> assembler,
                                                                                                                            @RequestParam(value="containerId")
                                                                                                                            java.lang.String containerId)

List the module metadata for all the modules that are deployed to the given container.

Parameters:

pageable - pagination information

assembler - paged resource assembler

containerId - the container id of the container to choose

Returns:

paged ModuleMetadataResource

listByModule

@RequestMapping(value="",
                method=GET,
                params="moduleId")
@ResponseStatus(value=OK)
@ResponseBody
public org.springframework.hateoas.PagedResources<ModuleMetadataResource> listByModule(org.springframework.data.domain.Pageable pageable,
                                                                                                                         org.springframework.data.web.PagedResourcesAssembler<ModuleMetadata> assembler,
                                                                                                                         @RequestParam(value="moduleId")
                                                                                                                         java.lang.String moduleId)

List the module metadata for all the modules with the given moduleId.

Parameters:

pageable - pagination information

assembler - paged resource assembler

moduleId - the module id of the module metadata to list

Returns:

paged ModuleMetadataResource

listByContainerAndModuleId

@RequestMapping(value="",
                method=GET,
                params={"containerId","moduleId"})
@ResponseStatus(value=OK)
@ResponseBody
public ModuleMetadataResource listByContainerAndModuleId(@RequestParam(value="containerId")
                                                                                           java.lang.String containerId,
                                                                                           @RequestParam(value="moduleId")
                                                                                           java.lang.String moduleId)

List the module metadata for the given moduleId and deployed to the given containerId.

Parameters:

containerId - the container id of the container to choose

moduleId - the module id of the module metadata to list

Returns:

the ModuleMetadataResource of the module

displayForJobname

@RequestMapping(value="",
                method=GET,
                params="jobname")
@ResponseStatus(value=OK)
@ResponseBody
public java.util.List<ModuleMetadataResource> displayForJobname(@RequestParam(value="jobname")
                                                                                                  java.lang.String jobName)

Will return a collection of ModuleMetadata that are associated with the provided jobname request parameter.

Parameters:

jobName - parameter must not be null

Returns:

Collection of ModuleMetadata, might be empty but never null