org.springframework.cloud.dataflow.server.controller

Class StreamDeploymentController

java.lang.Object

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

@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

Constructor Summary

Constructors

Constructor and Description

StreamDeploymentController(StreamDefinitionRepository repository, DeploymentIdRepository deploymentIdRepository, AppRegistry registry, org.springframework.cloud.deployer.spi.app.AppDeployer deployer, ApplicationConfigurationMetadataResolver metadataResolver, CommonApplicationProperties commonProperties) Create a StreamDeploymentController that delegates CRUD operations to the provided StreamDefinitionRepository app retrieval to the provided AppRegistry deployment operations to the provided AppDeployer

Method Summary

Modifier and Type	Method and Description
void	deploy(String name, Map<String,String> properties) 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,
                                  DeploymentIdRepository deploymentIdRepository,
                                  AppRegistry registry,
                                  org.springframework.cloud.deployer.spi.app.AppDeployer deployer,
                                  ApplicationConfigurationMetadataResolver metadataResolver,
                                  CommonApplicationProperties commonProperties)

Create a StreamDeploymentController that delegates

• CRUD operations to the provided StreamDefinitionRepository
• app retrieval to the provided AppRegistry
• deployment operations to the provided AppDeployer

Parameters:

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

deploymentIdRepository - the repository this controller will use for deployment IDs

registry - the registry this controller will use to lookup apps

deployer - the deployer this controller will use to deploy stream apps

metadataResolver - the application metadata resolver

commonProperties - common set of application properties

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.

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