org.springframework.cloud.deployer.spi.app

Class AppStatus

java.lang.Object

org.springframework.cloud.deployer.spi.app.AppStatus

public class AppStatus
extends Object

Status of an app which is initially constructed from an AppDeploymentRequest and runtime deployment properties by a deployer during deployment. This status is composed of an aggregate of all individual app instance deployments.

Consumers of the SPI obtain the app status via AppDeployer.status(String) , whereas SPI implementations create instances of this class via AppStatus.Builder.

Author:

Patrick Peralta, Mark Fisher

See Also:

AppInstanceStatus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppStatus.Builder Utility class constructing an instance of AppStatus using a builder pattern.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AppStatus(String deploymentId, DeploymentState generalState) Construct a new AppStatus.

Method Summary

Modifier and Type	Method and Description
String	getDeploymentId() Return the app deployment id.
Map<String,AppInstanceStatus>	getInstances() Return a map of AppInstanceStatus keyed by a unique identifier for each app instance.
DeploymentState	getState() Return the deployment state for the the app.
static AppStatus.Builder	of(String id) Return a Builder for AppStatus.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AppStatus

protected AppStatus(String deploymentId,
                    DeploymentState generalState)

Construct a new AppStatus.

Parameters:

deploymentId - id of the app this status is for

generalState - a value for general state of the app, or null if this should be derived from instances

Method Detail

getDeploymentId

public String getDeploymentId()

Return the app deployment id.

Returns:

app deployment id

getState

public DeploymentState getState()

Return the deployment state for the the app. If the descriptor indicates multiple instances, this state represents an aggregate of all individual app instances.

Returns:

deployment state for the app

toString

public String toString()

Overrides:

toString in class Object

getInstances

public Map<String,AppInstanceStatus> getInstances()

Return a map of AppInstanceStatus keyed by a unique identifier for each app instance.

Returns:

map of AppInstanceStatus

of

public static AppStatus.Builder of(String id)

Return a Builder for AppStatus.

Parameters:

id - of the app this status is for

Returns:

Builder for AppStatus