Package org.springframework.cloud.dataflow.server.controller

Class StreamDefinitionController

java.lang.Object

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

@RestController
@RequestMapping("/streams/definitions")
@ExposesResourceFor(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, Christian Tzolov, Andy Clement

Constructor Summary

Constructors

Constructor	Description
StreamDefinitionController(StreamService streamService, StreamDefinitionService streamDefinitionService, AppRegistryService appRegistryService, StreamDefinitionAssemblerProvider<? extends StreamDefinitionResource> streamDefinitionAssemblerProvider, AppRegistrationAssemblerProvider<? extends AppRegistrationResource> appRegistrationAssemblerProvider)	Create a StreamDefinitionController that delegates to StreamService.

Method Summary

Modifier and Type	Method	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.PagedModel<? extends 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.
List<? extends AppRegistrationResource>	listApplications(String name)
org.springframework.hateoas.PagedModel<? extends 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, String description, boolean deploy)	Create a new stream and optionally deploy it.
StreamDefinitionResource	saveWithDeployProps(String name, String dsl, String description, boolean deploy, Map<String,String> deploymentProperties)	Create a new stream and optionally deploy it.

Methods inherited from class java.lang.Object

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

Constructor Details

StreamDefinitionController

public StreamDefinitionController(StreamService streamService,
 StreamDefinitionService streamDefinitionService,
 AppRegistryService appRegistryService,
 StreamDefinitionAssemblerProvider<? extends StreamDefinitionResource> streamDefinitionAssemblerProvider,
 AppRegistrationAssemblerProvider<? extends AppRegistrationResource> appRegistrationAssemblerProvider)

Create a StreamDefinitionController that delegates to StreamService.

Parameters:

streamService - the stream service to use

streamDefinitionService - the stream definition service to use

appRegistryService - the app registry service to use

streamDefinitionAssemblerProvider - the stream definition assembler provider to use

appRegistrationAssemblerProvider - the app registry assembler provider to use

Method Details

list

@GetMapping("")
@ResponseStatus(OK)
public org.springframework.hateoas.PagedModel<? extends 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 - Pagination information

assembler - assembler for StreamDefinition

search - optional findByTaskNameContains parameter

Returns:

list of stream definitions

save

@PostMapping(value="",
             consumes="application/x-www-form-urlencoded")
@ResponseStatus(CREATED)
public StreamDefinitionResource save(@RequestParam
 String name,
 @RequestParam("definition")
 String dsl,
 @RequestParam(defaultValue="")
 String description,
 @RequestParam(defaultValue="false")
 boolean deploy)

Create a new stream and optionally deploy it.

Differs from saveWithDeployProps(java.lang.String, java.lang.String, java.lang.String, boolean, java.util.Map<java.lang.String, java.lang.String>) by accepting deployment properties and consuming MediaType.APPLICATION_FORM_URLENCODED request content (required by the Dataflow Shell).

Parameters:

name - stream name

dsl - DSL definition for stream

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

description - description of the stream definition

Returns:

the created stream definition

Throws:

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

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

saveWithDeployProps

@PostMapping(value="",
             consumes="application/json")
@ResponseStatus(CREATED)
public StreamDefinitionResource saveWithDeployProps(@RequestParam
 String name,
 @RequestParam("definition")
 String dsl,
 @RequestParam(defaultValue="")
 String description,
 @RequestParam(defaultValue="false")
 boolean deploy,
 @RequestBody(required=false)
 Map<String,String> deploymentProperties)

Create a new stream and optionally deploy it.

Differs from save(java.lang.String, java.lang.String, java.lang.String, boolean) by accepting deployment properties and consuming MediaType.APPLICATION_JSON request content.

Parameters:

name - stream name

dsl - DSL definition for stream

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

deploymentProperties - the optional deployment properties to use when the stream is deployed upon creation

description - description of the stream definition

Returns:

the created stream definition

Throws:

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

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

delete

@DeleteMapping("/{name}")
@ResponseStatus(OK)
public void delete(@PathVariable
 String name)

Request removal of an existing stream definition.

Parameters:

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

listRelated

@GetMapping("/{name}/related")
@ResponseStatus(OK)
public org.springframework.hateoas.PagedModel<? extends StreamDefinitionResource> listRelated(org.springframework.data.domain.Pageable pageable,
 @PathVariable
 String name,
 @RequestParam(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:

pageable - Pagination information

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

nested - if should recursively findByTaskNameContains for related stream definitions

assembler - resource assembler for stream definition

Returns:

a list of related stream definitions

display

@GetMapping("/{name}")
@ResponseStatus(OK)
public StreamDefinitionResource display(@PathVariable
 String name)

Return a given stream definition resource.

Parameters:

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

Returns:

the stream definition

listApplications

@GetMapping("/{name}/applications")
@ResponseStatus(OK)
public List<? extends AppRegistrationResource> listApplications(@PathVariable
 String name)

deleteAll

@DeleteMapping("")
@ResponseStatus(OK)
public void deleteAll()

Request removal of all stream definitions.