com.xebialabs.deployit.engine.api.dto

Class Deployment

java.lang.Object

com.xebialabs.deployit.engine.api.dto.AbstractDto

com.xebialabs.deployit.engine.api.dto.Deployment

public class Deployment
extends AbstractDto

The parameter object of a deployment action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Deployment.DeploymentType The type of deployment: INITIAL, UPDATE or UNDEPLOYMENT.

Constructor Summary

Constructors

Constructor and Description
Deployment()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem object) Adds a ConfigurationItem to the list of deployeds of this deployment.
void	addAll(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> deployeds) Adds a list of ConfigurationItems to the list of deployeds of this deployment.
java.util.List<ConfigurationItemId>	getContainers()
java.util.List<ConfigurationItemId>	getDeployables()
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	getDeployedApplication()
java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem>	getDeployeds()
Deployment.DeploymentType	getDeploymentType()
java.lang.String	getEnvironment()
java.lang.String	getId()
java.util.List<Deployment>	getRequiredDeployments()
java.lang.String	getVersion()
boolean	isOfType(Deployment.DeploymentType type)
void	setContainers(java.util.List<ConfigurationItemId> containers)
void	setDeployables(java.util.List<ConfigurationItemId> deployables)
void	setDeployedApplication(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem deployedApplication)
void	setDeployeds(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> deployeds)
void	setDeploymentType(Deployment.DeploymentType deploymentType)
void	setId(java.lang.String id)
void	setRequiredDeployments(java.util.List<Deployment> requiredDeployments)

Methods inherited from class com.xebialabs.deployit.engine.api.dto.AbstractDto

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Deployment

public Deployment()

Method Detail

getId

public java.lang.String getId()

Returns:

The id of the deployment action.

setId

public void setId(java.lang.String id)

Parameters:

id - The id of the deployment action.

getDeployedApplication

public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem getDeployedApplication()

Returns:

The application being deployed, upgraded or undeployed.

getDeployeds

public java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> getDeployeds()

Returns:

A list of ConfigurationItems representing the deployeds of this deployment.

getDeploymentType

public Deployment.DeploymentType getDeploymentType()

Returns:

The Deployment.DeploymentType of the current deployment.

setDeploymentType

public void setDeploymentType(Deployment.DeploymentType deploymentType)

Parameters:

deploymentType - The Deployment.DeploymentType of the current deployment.

isOfType

public boolean isOfType(Deployment.DeploymentType type)

Parameters:

type - The Deployment.DeploymentType to check against.

Returns:

Whether the current deployment has the given Deployment.DeploymentType.

setDeployedApplication

public void setDeployedApplication(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem deployedApplication)

Parameters:

deployedApplication - The application being deployed, upgraded or undeployed.

setDeployeds

public void setDeployeds(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> deployeds)

Parameters:

deployeds - A list of ConfigurationItems representing the deployeds of this deployment.

add

public void add(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem object)

Adds a ConfigurationItem to the list of deployeds of this deployment.

addAll

public void addAll(java.util.List<com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> deployeds)

Adds a list of ConfigurationItems to the list of deployeds of this deployment.

getVersion

public java.lang.String getVersion()

Returns:

The CI id of the deployed package.

getEnvironment

public java.lang.String getEnvironment()

Returns:

The CI id of the deployment environment.

getDeployables

public java.util.List<ConfigurationItemId> getDeployables()

Returns:

A list of CI references (ConfigurationItemIds) representing the deployables of this deployment.

setDeployables

public void setDeployables(java.util.List<ConfigurationItemId> deployables)

Parameters:

deployables - A list of CI references (ConfigurationItemIds) representing the deployables of this deployment.

getContainers

public java.util.List<ConfigurationItemId> getContainers()

Returns:

A list of CI references (ConfigurationItemIds) representing the containers of this deployment.

setContainers

public void setContainers(java.util.List<ConfigurationItemId> containers)

Parameters:

containers - A list of CI references (ConfigurationItemIds) representing the containers of this deployment.

getRequiredDeployments

public java.util.List<Deployment> getRequiredDeployments()

Returns:

A list of Deployments (Deployments) representing the dependent deployments.

setRequiredDeployments

public void setRequiredDeployments(java.util.List<Deployment> requiredDeployments)

Parameters:

requiredDeployments - A list of Deployments (Deployments) representing the dependent deployments.