org.springframework.xd.dirt.core

Class ModuleDeploymentsPath

java.lang.Object

org.springframework.xd.dirt.core.ModuleDeploymentsPath

public class ModuleDeploymentsPath
extends java.lang.Object

Builder object for paths under Paths.DEPLOYMENTS for module deployments. ModuleDeploymentsPath can be used to take a full path and split it into its elements, for example:

ModuleDeploymentsPath deploymentsPath = new ModuleDeploymentsPath("/xd/deployments/modules/4dbd28e2-880d-4774/my-stream.source.http-0"); assertEquals("my-stream", deploymentsPath.getStreamName());

It can also be used to build a path, for example:

ModuleDeploymentsPath deploymentsPath = new ModuleDeploymentsPath().setStreamName("my-stream").setContainer(...)...; assertEquals("/xd/deployments/modules/4dbd28e2-880d-4774/my-stream.source.http-0", deploymentsPath.build());

Author:

Patrick Peralta, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
ModuleDeploymentsPath() Construct a DeploymentsPath.
ModuleDeploymentsPath(java.lang.String path) Construct a DeploymentsPath.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	build() Build the path string using the field values.
java.lang.String	buildWithNamespace() Build the path string using the field values, including the namespace prefix.
java.lang.String	getContainer() Return the container name.
java.lang.String	getDeploymentUnitName() Return the deployment unit (Stream/Job) name.
java.lang.String	getModuleLabel() Return the module label.
int	getModuleSequence() Return the module sequence.
java.lang.String	getModuleSequenceAsString() Return the module sequence as string.
java.lang.String	getModuleType() Return the module type.
ModuleDeploymentsPath	setContainer(java.lang.String container) Set the container name.
ModuleDeploymentsPath	setDeploymentUnitName(java.lang.String deploymentUnitName) Set the deployment unit name.
ModuleDeploymentsPath	setModuleLabel(java.lang.String moduleLabel) Set the module label.
ModuleDeploymentsPath	setModuleSequence(java.lang.String moduleSequence) Set the module sequence.
ModuleDeploymentsPath	setModuleType(java.lang.String moduleType) Set the module type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDeploymentsPath

public ModuleDeploymentsPath()

Construct a DeploymentsPath. Use of this constructor means that a path will be created via build() or buildWithNamespace().

ModuleDeploymentsPath

public ModuleDeploymentsPath(java.lang.String path)

Construct a DeploymentsPath. Use of this constructor means that an existing path will be provided and this object will be used to extract the individual elements of the path. Both full paths (including and excluding the XD namespace prefix) are supported.

Parameters:

path - stream path

Method Detail

getContainer

public java.lang.String getContainer()

Return the container name.

Returns:

container name

setContainer

public ModuleDeploymentsPath setContainer(java.lang.String container)

Set the container name.

Parameters:

container - container name

Returns:

this object

getDeploymentUnitName

public java.lang.String getDeploymentUnitName()

Return the deployment unit (Stream/Job) name.

Returns:

deployment unit name

setDeploymentUnitName

public ModuleDeploymentsPath setDeploymentUnitName(java.lang.String deploymentUnitName)

Set the deployment unit name.

Parameters:

deploymentUnitName - deployment unit name

Returns:

this object

getModuleType

public java.lang.String getModuleType()

Return the module type.

Returns:

module type

setModuleType

public ModuleDeploymentsPath setModuleType(java.lang.String moduleType)

Set the module type.

Parameters:

moduleType - module type

Returns:

this object

getModuleLabel

public java.lang.String getModuleLabel()

Return the module label.

Returns:

module label

setModuleLabel

public ModuleDeploymentsPath setModuleLabel(java.lang.String moduleLabel)

Set the module label.

Parameters:

moduleLabel - module label

Returns:

this object

getModuleSequenceAsString

public java.lang.String getModuleSequenceAsString()

Return the module sequence as string.

Returns:

module sequence

getModuleSequence

public int getModuleSequence()

Return the module sequence.

Returns:

module sequence

setModuleSequence

public ModuleDeploymentsPath setModuleSequence(java.lang.String moduleSequence)

Set the module sequence.

Parameters:

moduleSequence - module sequence

Returns:

this object

build

public java.lang.String build()

Build the path string using the field values.

Returns:

path string

See Also:

Paths.build(java.lang.String...)

buildWithNamespace

public java.lang.String buildWithNamespace()

Build the path string using the field values, including the namespace prefix.

Returns:

path string with namespace

See Also:

Paths.buildWithNamespace(java.lang.String...)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object