org.springframework.cloud.dataflow.server.stream

Interface StreamDeployer

All Known Implementing Classes:

AppDeployerStreamDeployer, SkipperStreamDeployer

public interface StreamDeployer

SPI for handling deployment related operations on the apps in a stream.

Author:

Mark Pollack, Ilayaperumal Gopinathan, Christian Tzolov

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo	environmentInfo()
org.springframework.cloud.deployer.spi.app.AppStatus	getAppStatus(String appDeploymentId) Gets runtime application status
org.springframework.data.domain.Page<org.springframework.cloud.deployer.spi.app.AppStatus>	getAppStatuses(org.springframework.data.domain.Pageable pageable) Returns application statuses of all deployed applications
StreamDeployment	getStreamInfo(String streamName) Get stream information (including the deployment properties) for the given stream name.
Map<StreamDefinition,org.springframework.cloud.deployer.spi.app.DeploymentState>	streamsStates(List<StreamDefinition> content) Get the deployment states for a list of stream definitions
org.springframework.cloud.deployer.spi.app.DeploymentState	streamState(String streamName) Get the deployment state of a stream.

Method Detail

streamState

org.springframework.cloud.deployer.spi.app.DeploymentState streamState(String streamName)

Get the deployment state of a stream. Stream state is computed from the deployment states of its apps.

Parameters:

streamName - stream name

Returns:

the deployment status

streamsStates

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

Get the deployment states for a list of stream definitions

Parameters:

content -

Returns:

map of stream definition and its corresponding deployment state

getAppStatuses

org.springframework.data.domain.Page<org.springframework.cloud.deployer.spi.app.AppStatus> getAppStatuses(org.springframework.data.domain.Pageable pageable)
                                                                                                   throws ExecutionException,
                                                                                                          InterruptedException

Returns application statuses of all deployed applications

Parameters:

pageable -

Returns:

pagable list of all app statuses

Throws:

ExecutionException

InterruptedException

getAppStatus

org.springframework.cloud.deployer.spi.app.AppStatus getAppStatus(String appDeploymentId)

Gets runtime application status

Parameters:

appDeploymentId - the id of the application instance running in the target runtime environment

Returns:

app status

environmentInfo

org.springframework.cloud.deployer.spi.core.RuntimeEnvironmentInfo environmentInfo()

Returns:

the runtime environment info for deploying streams.

getStreamInfo

StreamDeployment getStreamInfo(String streamName)

Get stream information (including the deployment properties) for the given stream name.

Parameters:

streamName - the name of the stream

Returns:

stream deployment information