org.springframework.cloud.dataflow.server.controller

Class StreamDeploymentController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.StreamDeploymentController

Direct Known Subclasses:

SkipperStreamDeploymentController

@RestController
 @RequestMapping(value="/streams/deployments")
 @ExposesResourceFor(value=StreamDeploymentResource.class)
public class StreamDeploymentController
extends Object

Controller for deployment operations on StreamDefinition.

Author:

Eric Bottard, Mark Fisher, Patrick Peralta, Ilayaperumal Gopinathan, Marius Bogoevici, Janne Valkealahti, Christian Tzolov

Constructor Summary

Constructors

Constructor and Description
StreamDeploymentController(StreamDefinitionRepository repository, StreamService streamService) Create a StreamDeploymentController that delegates CRUD operations to the provided StreamDefinitionRepository deployment operations to the provided AppDeployer via StreamService

Method Summary

Modifier and Type	Method and Description
void	deploy(String name, Map<String,String> properties) Request deployment of an existing stream definition.
StreamDeploymentResource	info(String name) Request deployment of an existing stream definition.
void	undeploy(String name) Request un-deployment of an existing stream.
void	undeployAll() Request un-deployment of all streams.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamDeploymentController

public StreamDeploymentController(StreamDefinitionRepository repository,
                                  StreamService streamService)

Create a StreamDeploymentController that delegates

• CRUD operations to the provided StreamDefinitionRepository
• deployment operations to the provided AppDeployer via StreamService

Parameters:

repository - the repository this controller will use for stream CRUD operations

streamService - the underlying StreamService to deploy the stream

Method Detail

undeploy

@RequestMapping(value="/{name}",
                method=DELETE)
 @ResponseStatus(value=OK)
public void undeploy(@PathVariable(value="name")
                                                                                                                String name)

Request un-deployment of an existing stream.

Parameters:

name - the name of an existing stream (required)

undeployAll

@RequestMapping(value="",
                method=DELETE)
 @ResponseStatus(value=OK)
public void undeployAll()

Request un-deployment of all streams.

info

@RequestMapping(value="/{name}",
                method=GET)
 @ResponseStatus(value=CREATED)
public StreamDeploymentResource info(@PathVariable(value="name")
                                                                                                                                  String name)

Request deployment of an existing stream definition.

Parameters:

name - the name of an existing stream definition (required)

deploy

@RequestMapping(value="/{name}",
                method=POST)
 @ResponseStatus(value=CREATED)
public void deploy(@PathVariable(value="name")
                                                                                                                 String name,
                                                                                                                 @RequestBody(required=false)
                                                                                                                 Map<String,String> properties)

Request deployment of an existing stream definition.

Parameters:

name - the name of an existing stream definition (required)

properties - the deployment properties for the stream as a comma-delimited list of key=value pairs