com.xebialabs.gradle.xldeploy

Class DeploymentHelper

java.lang.Object

com.xebialabs.gradle.xldeploy.DeploymentHelper

public class DeploymentHelper
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeploymentHelper.DeploymentValidationError
static class	DeploymentHelper.EnvironmentAlreadyExistsError

Field Summary

Fields

Modifier and Type	Field and Description
static int	TASK_WAIT_TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
DeploymentHelper(org.gradle.api.logging.Logger logger, com.xebialabs.deployit.booter.remote.DeployitCommunicator communicator)

Method Summary

Methods

Modifier and Type	Method and Description
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	createEnvironment(java.lang.String id, java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> members) Creates an environment with members
com.xebialabs.deployit.engine.api.execution.TaskExecutionState	executeAndArchiveTask(java.lang.String taskId) Starts task, waits until it's done.
boolean	isApplicationDeployed(java.lang.String source, java.lang.String target) Checks whether application from given source is deployed to given target
void	logEnvironment(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem envCi) logs environment and it's members
void	logStepState(java.lang.String taskId, int stepNumber) Logs information about single step
void	logTaskState(java.lang.String taskId) Logs information about task and all steps
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	readCiOrNull(java.lang.String environmentId) Returns configuration item from repository, or null if it does not exist
void	skipAllSteps(java.lang.String taskId) Skips all steps of the given task
com.xebialabs.deployit.plugin.api.udm.ConfigurationItem	uploadPackage(java.io.File darFile) Uploads and imports a .dar package to deployit.
com.xebialabs.deployit.engine.api.dto.Deployment	validateDeployment(com.xebialabs.deployit.engine.api.dto.Deployment deployment) Checks if deployment valid (does not contain validation messages)

Methods inherited from class java.lang.Object

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

Field Detail

TASK_WAIT_TIMEOUT_MS

public static final int TASK_WAIT_TIMEOUT_MS

See Also:

Constant Field Values

Constructor Detail

DeploymentHelper

public DeploymentHelper(org.gradle.api.logging.Logger logger,
                com.xebialabs.deployit.booter.remote.DeployitCommunicator communicator)

Method Detail

isApplicationDeployed

public boolean isApplicationDeployed(java.lang.String source,
                            java.lang.String target)

Checks whether application from given source is deployed to given target

skipAllSteps

public void skipAllSteps(java.lang.String taskId)

Skips all steps of the given task

executeAndArchiveTask

public com.xebialabs.deployit.engine.api.execution.TaskExecutionState executeAndArchiveTask(java.lang.String taskId)

Starts task, waits until it's done. Returns one of the states: {DONE, EXECUTED, STOPPED, CANCELLED}.

logTaskState

public void logTaskState(java.lang.String taskId)

Logs information about task and all steps

logStepState

public void logStepState(java.lang.String taskId,
                int stepNumber)

Logs information about single step

validateDeployment

public com.xebialabs.deployit.engine.api.dto.Deployment validateDeployment(com.xebialabs.deployit.engine.api.dto.Deployment deployment)
                                                                    throws DeploymentHelper.DeploymentValidationError

Checks if deployment valid (does not contain validation messages)

Throws:

DeploymentHelper.DeploymentValidationError

readCiOrNull

public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem readCiOrNull(java.lang.String environmentId)

Returns configuration item from repository, or null if it does not exist

logEnvironment

public void logEnvironment(com.xebialabs.deployit.plugin.api.udm.ConfigurationItem envCi)

logs environment and it's members

createEnvironment

public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem createEnvironment(java.lang.String id,
                                                                        java.util.List<? extends com.xebialabs.deployit.plugin.api.udm.ConfigurationItem> members)
                                                                          throws DeploymentHelper.EnvironmentAlreadyExistsError

Creates an environment with members

Throws:

DeploymentHelper.EnvironmentAlreadyExistsError

uploadPackage

public com.xebialabs.deployit.plugin.api.udm.ConfigurationItem uploadPackage(java.io.File darFile)

Uploads and imports a .dar package to deployit.