org.springframework.xd.rest.client.impl

Class ModuleTemplate

java.lang.Object

org.springframework.xd.rest.client.impl.ModuleTemplate

All Implemented Interfaces:

ModuleOperations

public class ModuleTemplate
extends java.lang.Object
implements ModuleOperations

Implementation of the Module-related part of the API.

Author:

Eric Bottard, Glenn Renfro, Mark Fisher, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.springframework.hateoas.UriTemplate>	resources Holds discovered URLs of the API.
protected org.springframework.web.client.RestTemplate	restTemplate A template used for http interaction.

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.
ModuleDefinitionResource.Page	list(RESTModuleType type) List modules known to the system.
java.lang.String	toString()
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.

Methods inherited from class java.lang.Object

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

Field Detail

restTemplate

protected org.springframework.web.client.RestTemplate restTemplate

A template used for http interaction.

resources

protected java.util.Map<java.lang.String,org.springframework.hateoas.UriTemplate> resources

Holds discovered URLs of the API.

Method Detail

composeModule

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

Description copied from interface: ModuleOperations

Compose a new composed Module.

Specified by:

composeModule in interface ModuleOperations

deleteModule

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

Description copied from interface: ModuleOperations

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

Specified by:

deleteModule in interface ModuleOperations

info

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

Description copied from interface: ModuleOperations

Retrieve information about a particular module.

Specified by:

info in interface ModuleOperations

uploadModule

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

Description copied from interface: ModuleOperations

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

Specified by:

uploadModule in interface ModuleOperations

Throws:

java.io.IOException

list

public ModuleDefinitionResource.Page list(RESTModuleType type)

Description copied from interface: ModuleOperations

List modules known to the system.

Specified by:

list in interface ModuleOperations

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object