org.springframework.xd.dirt.rest

Class StreamsController

java.lang.Object

org.springframework.xd.dirt.rest.XDController<StreamDefinition,StreamDefinitionResourceAssembler,StreamDefinitionResource,Stream>

org.springframework.xd.dirt.rest.StreamsController

@Controller
@RequestMapping(value="/streams")
@ExposesResourceFor(value=StreamDefinitionResource.class)
public class StreamsController
extends XDController<StreamDefinition,StreamDefinitionResourceAssembler,StreamDefinitionResource,Stream>

Handles all Stream related interaction.

Since:

1.0

Author:

Eric Bottard, Gunnar Hillert, David Turanski, Gary Russell

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.xd.dirt.rest.XDController

XDController.QueryOptions

Field Summary

Fields inherited from class org.springframework.xd.dirt.rest.XDController

deployer

Constructor Summary

Constructors

Constructor and Description
StreamsController(StreamDeployer streamDeployer)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	clean(java.lang.String stream, java.lang.String adminUri, java.lang.String user, java.lang.String pw, java.lang.String vhost, java.lang.String busPrefix)
protected StreamDefinition	createDefinition(java.lang.String name, java.lang.String definition)
org.springframework.hateoas.PagedResources<StreamDefinitionResource>	list(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<StreamDefinition> assembler) List stream definitions.

Methods inherited from class org.springframework.xd.dirt.rest.XDController

cleanRabbitBus, delete, deleteAll, deploy, display, listValues, save, undeploy, undeployAll

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamsController

@Autowired
public StreamsController(StreamDeployer streamDeployer)

Method Detail

list

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

List stream definitions.

createDefinition

protected StreamDefinition createDefinition(java.lang.String name,
                                java.lang.String definition)

Specified by:

createDefinition in class XDController<StreamDefinition,StreamDefinitionResourceAssembler,StreamDefinitionResource,Stream>

clean

@ResponseBody
@RequestMapping(value="/clean/rabbit/{stream}",
                method=DELETE)
@ResponseStatus(value=OK)
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> clean(@PathVariable
                                                                                                                java.lang.String stream,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String adminUri,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String user,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String pw,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String vhost,
                                                                                                                @RequestParam(required=false)
                                                                                                                java.lang.String busPrefix)