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, Eric Bottard

Method Summary

Methods

Modifier and Type	Method and Description
ModuleDefinitionResource	composeModule(java.lang.String name, java.lang.String definition, boolean force) Compose a new composed Module.
void	deleteModule(java.lang.String name, RESTModuleType moduleType) Request deletion of module with given name and type.
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.
ModuleDefinitionResource	uploadModule(java.lang.String name, RESTModuleType type, org.springframework.core.io.Resource bytes, boolean force) Create a new module by uploading the contents of an archive.

Method Detail

composeModule

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

Compose a new composed Module.

list

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

List modules known to the system.

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.

uploadModule

ModuleDefinitionResource uploadModule(java.lang.String name,
                                    RESTModuleType type,
                                    org.springframework.core.io.Resource bytes,
                                    boolean force)
                                      throws java.io.IOException

Create a new module by uploading the contents of an archive.

Throws:

java.io.IOException