org.springframework.cloud.dataflow.server.service.impl

Class AbstractStreamService

java.lang.Object

org.springframework.cloud.dataflow.server.service.impl.AbstractStreamService

All Implemented Interfaces:

StreamService

Direct Known Subclasses:

AppDeployerStreamService, DefaultSkipperStreamService

@Transactional
public abstract class AbstractStreamService
extends Object
implements StreamService

Performs manipulation on application and deployment properties, expanding shorthand application property values, resolving wildcard deployment properties, and creates a StreamDeploymentRequest.

The AbstractStreamService deployer is agnostic. For deploying streams on Skipper use the DefaultSkipperStreamService and for the AppDeploy stream deployment use the AppDeployerStreamService.

Author:

Mark Pollack, Ilayaperumal Gopinathan, Christian Tzolov

Field Summary

Fields

Modifier and Type	Field and Description
protected StreamDefinitionRepository	streamDefinitionRepository The repository this controller will use for stream CRUD operations.

Constructor Summary

Constructors

Constructor and Description
AbstractStreamService(StreamDefinitionRepository streamDefinitionRepository, AppRegistryCommon appRegistry) Constructor for implementations of the StreamService.

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.
protected abstract org.springframework.cloud.deployer.spi.app.DeploymentState	doCalculateStreamState(String name)
protected abstract void	doDeployStream(StreamDefinition streamDefinition, Map<String,String> deploymentProperties)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.dataflow.server.service.StreamService

info, state, undeployStream

Field Detail

streamDefinitionRepository

protected final StreamDefinitionRepository streamDefinitionRepository

The repository this controller will use for stream CRUD operations.

Constructor Detail

AbstractStreamService

public AbstractStreamService(StreamDefinitionRepository streamDefinitionRepository,
                             AppRegistryCommon appRegistry)

Constructor for implementations of the StreamService.

Parameters:

streamDefinitionRepository - the stream definition repository to use

appRegistry - the application registry to use

Method Detail

createStream

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

Description copied from interface: StreamService

Create a new stream.

Specified by:

createStream in interface StreamService

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

deployStream

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

Description copied from interface: StreamService

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

Specified by:

deployStream in interface StreamService

Parameters:

name - the name of the stream

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

doDeployStream

protected abstract void doDeployStream(StreamDefinition streamDefinition,
                                       Map<String,String> deploymentProperties)

doCalculateStreamState

protected abstract org.springframework.cloud.deployer.spi.app.DeploymentState doCalculateStreamState(String name)

deleteStream

public void deleteStream(String name)

Description copied from interface: StreamService

Delete the stream, including undeloying.

Specified by:

deleteStream in interface StreamService

Parameters:

name - the name of the stream to delete

deleteAll

public void deleteAll()

Description copied from interface: StreamService

Delete all streams, including undeploying.

Specified by:

deleteAll in interface StreamService

findRelatedStreams

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

Description copied from interface: StreamService

Find streams related to the given stream name.

Specified by:

findRelatedStreams in interface StreamService

Parameters:

name - name of the stream

nested - if should recursively findByNameLike for related stream definitions

Returns:

a list of related stream definitions

findDefinitionByNameLike

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

Description copied from interface: StreamService

Find stream definitions where the findByNameLike parameter

Specified by:

findDefinitionByNameLike in interface StreamService

searchName - the findByNameLike parameter to use

Returns:

Page of stream definitions

findOne

public StreamDefinition findOne(String streamDefinitionName)

Description copied from interface: StreamService

Find a stream definition by name.

Specified by:

findOne in interface StreamService

Parameters:

streamDefinitionName - the name of the stream definition

Returns:

the stream definition