Package com.atlassian.bamboo.deployments.execution.service

Interface DeploymentExecutionService

All Known Implementing Classes:

DeploymentExecutionServiceImpl

@Internal
public interface DeploymentExecutionService

Method Summary

Modifier and Type	Method	Description
ExecutionRequestResult	execute(Environment environment, @NotNull EnvironmentTriggeringAction action)	Start DeploymentContext execution.
boolean	isEnvironmentBeingDeployedTo(long environmentId)	Check if Environment is currently being deployed to
DeploymentContext	prepareDeploymentContext(@NotNull Environment environment, @NotNull DeploymentVersion deploymentVersion, @NotNull TriggerReason triggerReason)	Prepare DeploymentContext out of Environment and DeploymentVersion
DeploymentContext	prepareDeploymentContext(@NotNull Environment environment, @NotNull DeploymentVersion deploymentVersion, @NotNull TriggerReason triggerReason, boolean isVerboseLoggingOn)	Prepare DeploymentContext out of Environment and DeploymentVersion
void	processDeploymentResult(@NotNull DeploymentContext deploymentContext)	Process result that has come back from the agent.
void	restoreStateOfResult(@NotNull DeploymentResult deploymentResult)	Restores internal state of single deployment result after server restart.
void	stop(long environmentId)	Stops the execution of a deployment running on an Environment.
void	stop(@NotNull DeploymentResult deploymentResult, Long agentId)	Stops the execution of a running deployment
void	stopBeforeDeletion(long environmentId)	Stops the execution of a deployment running on an Environment before deleting it.
void	terminateDeployment(@NotNull DeploymentResultKey resultKey)	Cleans up deployment result if execution has been terminated abrubtly.

Method Details

prepareDeploymentContext

DeploymentContext prepareDeploymentContext(@NotNull
 @NotNull Environment environment,
 @NotNull
 @NotNull DeploymentVersion deploymentVersion,
 @NotNull
 @NotNull TriggerReason triggerReason)
                                    throws DeploymentDoesNotSatisfyPrerequisitesException

Prepare DeploymentContext out of Environment and DeploymentVersion

Parameters:

environment -

deploymentVersion -

triggerReason -

Throws:

DeploymentDoesNotSatisfyPrerequisitesException - if prerequisites needed to launch the deployment are not satisfied

prepareDeploymentContext

DeploymentContext prepareDeploymentContext(@NotNull
 @NotNull Environment environment,
 @NotNull
 @NotNull DeploymentVersion deploymentVersion,
 @NotNull
 @NotNull TriggerReason triggerReason,
 boolean isVerboseLoggingOn)
                                    throws DeploymentDoesNotSatisfyPrerequisitesException

Prepare DeploymentContext out of Environment and DeploymentVersion

Parameters:

environment -

deploymentVersion -

triggerReason -

isVerboseLoggingOn -

Throws:

DeploymentDoesNotSatisfyPrerequisitesException - if prerequisites needed to launch the deployment are not satisfied

execute

ExecutionRequestResult execute(Environment environment,
 @NotNull
 @NotNull EnvironmentTriggeringAction action)

Start DeploymentContext execution. Before putting DeploymentContext into execution pipeline this method checks if Environment is not running any other deployment.

stop

void stop(long environmentId)

Stops the execution of a deployment running on an Environment.

Parameters:

environmentId - id of the Environment

stopBeforeDeletion

void stopBeforeDeletion(long environmentId)

Stops the execution of a deployment running on an Environment before deleting it.

Parameters:

environmentId - id of the Environment

stop

void stop(@NotNull
 @NotNull DeploymentResult deploymentResult,
 Long agentId)

Stops the execution of a running deployment

Parameters:

deploymentResult - of the deployment we want to stop

agentId - agent on which the deployment is running

processDeploymentResult

void processDeploymentResult(@NotNull
 @NotNull DeploymentContext deploymentContext)

Process result that has come back from the agent.

Parameters:

deploymentContext - from the agent.

isEnvironmentBeingDeployedTo

boolean isEnvironmentBeingDeployedTo(long environmentId)

Check if Environment is currently being deployed to

Parameters:

environmentId - id of the Environment

Returns:

true if

terminateDeployment

void terminateDeployment(@NotNull
 @NotNull DeploymentResultKey resultKey)

Cleans up deployment result if execution has been terminated abrubtly.

Parameters:

resultKey -

restoreStateOfResult

void restoreStateOfResult(@NotNull
 @NotNull DeploymentResult deploymentResult)

Restores internal state of single deployment result after server restart.

Parameters:

deploymentResult - a restored result