org.springframework.cloud.dataflow.server.service

Interface StreamService

All Known Subinterfaces:

SkipperStreamService

All Known Implementing Classes:

AbstractStreamService, AppDeployerStreamService, DefaultSkipperStreamService

public interface StreamService

Provide deploy, undeploy, info and state operations on the stream.

Author:

Mark Pollack, Ilayaperumal Gopinathan, Christian Tzolov

Method Summary

Modifier and Type	Method and Description
StreamDefinition	createStream(String streamName, String dsl, boolean deploy) Create a new stream.
void	deleteAll() Delete all streams, including undeploying.
void	deleteStream(String name) Delete the stream, including undeloying.
void	deployStream(String name, Map<String,String> deploymentProperties) Deploys the stream with the user provided deployment properties.
org.springframework.data.domain.Page<StreamDefinition>	findDefinitionByNameLike(org.springframework.data.domain.Pageable pageable, String searchName) Find stream definitions where the findByNameLike parameter
StreamDefinition	findOne(String streamDefinitionName) Find a stream definition by name.
List<StreamDefinition>	findRelatedStreams(String name, boolean nested) Find streams related to the given stream name.
StreamDeployment	info(String streamName) Get stream information including the deployment properties etc.
Map<StreamDefinition,org.springframework.cloud.deployer.spi.app.DeploymentState>	state(List<StreamDefinition> streamDefinitions) Retrieve the deployment state for list of stream definitions.
void	undeployStream(String name) Un-deploys the stream identified by the given stream name.

Method Detail

createStream

StreamDefinition createStream(String streamName,
                              String dsl,
                              boolean deploy)

Create a new stream.

Parameters:

streamName - stream name

dsl - DSL definition for stream

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

Returns:

the created stream definition already exists

Throws:

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

deployStream

void deployStream(String name,
                  Map<String,String> deploymentProperties)

Deploys the stream with the user provided deployment properties. Implementations are responsible for expanding deployment wildcard expressions.

Parameters:

name - the name of the stream

deploymentProperties - deployment properties to use as passed in from the client.

undeployStream

void undeployStream(String name)

Un-deploys the stream identified by the given stream name.

Parameters:

name - the name of the stream to un-deploy

deleteStream

void deleteStream(String name)

Delete the stream, including undeloying.

Parameters:

name - the name of the stream to delete

deleteAll

void deleteAll()

Delete all streams, including undeploying.

state

Map<StreamDefinition,org.springframework.cloud.deployer.spi.app.DeploymentState> state(List<StreamDefinition> streamDefinitions)

Retrieve the deployment state for list of stream definitions.

Parameters:

streamDefinitions - the list of Stream definitions to calculate the deployment states.

Returns:

the map containing the stream definitions and their deployment states.

info

StreamDeployment info(String streamName)

Get stream information including the deployment properties etc.

Parameters:

streamName - the name of the stream

Returns:

the stream deployment information

findRelatedStreams

List<StreamDefinition> findRelatedStreams(String name,
                                          boolean nested)

Find streams related to the given stream name.

Parameters:

name - name of the stream

nested - if should recursively findByNameLike for related stream definitions

Returns:

a list of related stream definitions

findDefinitionByNameLike

org.springframework.data.domain.Page<StreamDefinition> findDefinitionByNameLike(org.springframework.data.domain.Pageable pageable,
                                                                                String searchName)

Find stream definitions where the findByNameLike parameter

Parameters:

searchName - the findByNameLike parameter to use

Returns:

Page of stream definitions

findOne

StreamDefinition findOne(String streamDefinitionName)

Find a stream definition by name.

Parameters:

streamDefinitionName - the name of the stream definition

Returns:

the stream definition

Throws:

NoSuchStreamDefinitionException - if the definition can not be found.