org.springframework.cloud.dataflow.server.controller

Class StreamDefinitionController

java.lang.Object

org.springframework.cloud.dataflow.server.controller.StreamDefinitionController

@RestController
 @RequestMapping(value="/streams/definitions")
 @ExposesResourceFor(value=StreamDefinitionResource.class)
public class StreamDefinitionController
extends Object

Controller for operations on StreamDefinition. This includes CRUD and optional deployment operations.

Author:

Eric Bottard, Mark Fisher, Patrick Peralta, Ilayaperumal Gopinathan, Gunnar Hillert, Oleg Zhurakousky, Glenn Renfro

Constructor Summary

Constructors

Constructor and Description

StreamDefinitionController(StreamDefinitionRepository repository, DeploymentIdRepository deploymentIdRepository, StreamDeploymentController deploymentController, org.springframework.cloud.deployer.spi.app.AppDeployer deployer, AppRegistry appRegistry) Create a StreamDefinitionController that delegates CRUD operations to the provided StreamDefinitionRepository deployment ID operations to the provided DeploymentIdRepository deployment operations to the provided StreamDeploymentController deployment status computation to the provided AppDeployer

Method Summary

Modifier and Type	Method and Description
void	delete(String name) Request removal of an existing stream definition.
void	deleteAll() Request removal of all stream definitions.
StreamDefinitionResource	display(String name) Return a given stream definition resource.
org.springframework.hateoas.PagedResources<StreamDefinitionResource>	list(org.springframework.data.domain.Pageable pageable, String search, org.springframework.data.web.PagedResourcesAssembler<StreamDefinition> assembler) Return a page-able list of StreamDefinitionResource defined streams.
org.springframework.hateoas.PagedResources<StreamDefinitionResource>	listRelated(org.springframework.data.domain.Pageable pageable, String name, boolean nested, org.springframework.data.web.PagedResourcesAssembler<StreamDefinition> assembler) Return a list of related stream definition resources based on the given stream name.
StreamDefinitionResource	save(String name, String dsl, boolean deploy) Create a new stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamDefinitionController

public StreamDefinitionController(StreamDefinitionRepository repository,
                                  DeploymentIdRepository deploymentIdRepository,
                                  StreamDeploymentController deploymentController,
                                  org.springframework.cloud.deployer.spi.app.AppDeployer deployer,
                                  AppRegistry appRegistry)

Create a StreamDefinitionController that delegates

• CRUD operations to the provided StreamDefinitionRepository
• deployment ID operations to the provided DeploymentIdRepository
• deployment operations to the provided StreamDeploymentController
• deployment status computation 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

deploymentController - the deployment controller to delegate deployment operations

deployer - the deployer this controller will use to compute deployment status

appRegistry - the app registry to look up registered apps

Method Detail

list

@RequestMapping(value="",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<StreamDefinitionResource> list(org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                  @RequestParam(required=false)
                                                                                                                                                                  String search,
                                                                                                                                                                  org.springframework.data.web.PagedResourcesAssembler<StreamDefinition> assembler)

Return a page-able list of StreamDefinitionResource defined streams.

Parameters:

pageable - page-able collection of StreamDefinitionResources.

assembler - assembler for StreamDefinition

search - optional search parameter

Returns:

list of stream definitions

save

@RequestMapping(value="",
                method=POST)
 @ResponseStatus(value=CREATED)
public StreamDefinitionResource save(@RequestParam(value="name")
                                                                                                                            String name,
                                                                                                                            @RequestParam(value="definition")
                                                                                                                            String dsl,
                                                                                                                            @RequestParam(value="deploy",defaultValue="false")
                                                                                                                            boolean deploy)

Create a new stream.

Parameters:

name - stream name

dsl - DSL definition for stream

deploy - if true, the stream is deployed upon creation (default is false)

Returns:

the created stream definition

Throws:

DuplicateStreamDefinitionException - if a stream definition with the same name already exists

InvalidStreamDefinitionException - if there errors in parsing the strem DSL, resolving the name, or type of applications in the stream

delete

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

Request removal of an existing stream definition.

Parameters:

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

listRelated

@RequestMapping(value="/{name}/related",
                method=GET)
 @ResponseStatus(value=OK)
public org.springframework.hateoas.PagedResources<StreamDefinitionResource> listRelated(org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                        @PathVariable(value="name")
                                                                                                                                                                                        String name,
                                                                                                                                                                                        @RequestParam(value="nested",required=false,defaultValue="false")
                                                                                                                                                                                        boolean nested,
                                                                                                                                                                                        org.springframework.data.web.PagedResourcesAssembler<StreamDefinition> assembler)

Return a list of related stream definition resources based on the given stream name. Related streams include the main stream and the tap stream(s) on the main stream.

Parameters:

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

nested - if should recursively search for related stream definitions

assembler - resource assembler for stream definition

Returns:

a list of related stream definitions

display

@RequestMapping(value="/{name}",
                method=GET)
 @ResponseStatus(value=OK)
public StreamDefinitionResource display(@PathVariable(value="name")
                                                                                                                                String name)

Return a given stream definition resource.

Parameters:

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

Returns:

the stream definition

deleteAll

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

Request removal of all stream definitions.