org.springframework.xd.dirt.server.admin.deployment

Class ModuleDeploymentStatus

java.lang.Object

org.springframework.xd.dirt.server.admin.deployment.ModuleDeploymentStatus

public class ModuleDeploymentStatus
extends java.lang.Object

Status of a module deployment for a container. In addition to the get... methods, this class provides a toMap() method which returns a map that contains the state and error description which can be written to ZooKeeper. The module deployment status path can be obtained via buildPath().

Author:

Patrick Peralta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleDeploymentStatus.State Module deployment states.

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentStatus(java.lang.String container, int moduleSequence, ModuleDescriptor.Key key, java.util.Map<java.lang.String,java.lang.String> map) Construct a ModuleDeploymentStatus.
ModuleDeploymentStatus(java.lang.String container, int moduleSequence, ModuleDescriptor.Key key, ModuleDeploymentStatus.State state, java.lang.String errorDescription) Construct a ModuleDeploymentStatus.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	buildPath() Return the ZooKeeper path that this module deployment status should be written to
java.lang.String	getContainer()
java.lang.String	getErrorDescription()
ModuleDescriptor.Key	getKey()
int	getModuleSequence()
java.lang.String	getModuleSequenceAsString()
ModuleDeploymentStatus.State	getState()
java.util.Map<java.lang.String,java.lang.String>	toMap() Return a map containing the state and error description (if any) for this status.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeploymentStatus

public ModuleDeploymentStatus(java.lang.String container,
                      int moduleSequence,
                      ModuleDescriptor.Key key,
                      ModuleDeploymentStatus.State state,
                      java.lang.String errorDescription)

Construct a ModuleDeploymentStatus.

Parameters:

container - target container name

moduleSequence - module sequence number

key - module descriptor key

state - deployment state

errorDescription - error description (may be null)

ModuleDeploymentStatus

public ModuleDeploymentStatus(java.lang.String container,
                      int moduleSequence,
                      ModuleDescriptor.Key key,
                      java.util.Map<java.lang.String,java.lang.String> map)

Construct a ModuleDeploymentStatus.

Parameters:

container - target container name

moduleSequence - module sequence number

key - module descriptor key

map - map containing status and (possibly) an error description

Method Detail

getContainer

public java.lang.String getContainer()

Returns:

target container name

See Also:

container

getModuleSequence

public int getModuleSequence()

Returns:

module sequence number

See Also:

moduleSequence

getModuleSequenceAsString

public java.lang.String getModuleSequenceAsString()

Returns:

module sequence number as string

See Also:

moduleSequence

getKey

public ModuleDescriptor.Key getKey()

Returns:

module descriptor key

See Also:

key

getState

public ModuleDeploymentStatus.State getState()

Returns:

module deployment status

See Also:

state

getErrorDescription

public java.lang.String getErrorDescription()

Returns:

error description; may be null

See Also:

errorDescription

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()

Return a map containing the state and error description (if any) for this status. This map may be serialized into ZooKeeper to write out the module deployment status.

Returns:

map containing the module deployment status

See Also:

buildPath()

buildPath

public java.lang.String buildPath()

Return the ZooKeeper path that this module deployment status should be written to

Returns:

path for this status

See Also:

toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object