org.springframework.xd.rest.client

Interface ModuleOperations

All Known Implementing Classes:

ModuleTemplate

public interface ModuleOperations

Interface defining operations available against Module.

Author:

Glenn Renfro, Gunnar Hillert

Method Summary

Methods

Modifier and Type	Method and Description
ModuleDefinitionResource	composeModule(java.lang.String name, java.lang.String definition) Compose a new virtual Module.
void	deleteModule(java.lang.String name, RESTModuleType moduleType) Request deletion of module with given name and type.
java.lang.String	downloadConfigurationFile(RESTModuleType type, java.lang.String name) Get the configuration file associated with the provided module information.
DetailedModuleDefinitionResource	info(java.lang.String name, RESTModuleType type) Retrieve information about a particular module.
org.springframework.hateoas.PagedResources<ModuleDefinitionResource>	list(RESTModuleType type) List modules known to the system.

Method Detail

composeModule

ModuleDefinitionResource composeModule(java.lang.String name,
                                     java.lang.String definition)

Compose a new virtual Module.

list

org.springframework.hateoas.PagedResources<ModuleDefinitionResource> list(RESTModuleType type)

List modules known to the system.

downloadConfigurationFile

java.lang.String downloadConfigurationFile(RESTModuleType type,
                                         java.lang.String name)

Get the configuration file associated with the provided module information.

Parameters:

type - Must not be null

name - Must not be empty

Returns:

The file contents of the module

deleteModule

void deleteModule(java.lang.String name,
                RESTModuleType moduleType)

Request deletion of module with given name and type. Only composite modules, which are not currently in use can be deleted.

info

DetailedModuleDefinitionResource info(java.lang.String name,
                                    RESTModuleType type)

Retrieve information about a particular module.