com.xebialabs.deployit.plugin.generic.step

Class ArtifactDeleteStep

java.lang.Object

com.xebialabs.deployit.plugin.steps.CalculatedStep

com.xebialabs.deployit.plugin.generic.step.BaseStep

com.xebialabs.deployit.plugin.generic.step.BaseDeploymentStep

com.xebialabs.deployit.plugin.generic.step.ArtifactDeleteStep

All Implemented Interfaces:

com.xebialabs.deployit.plugin.api.flow.Step, com.xebialabs.deployit.plugin.steps.BaseStep, java.io.Serializable

public class ArtifactDeleteStep
extends BaseDeploymentStep

See Also:

Serialized Form

Field Summary

Fields inherited from class com.xebialabs.deployit.plugin.generic.step.BaseStep

container, ctx, FREEMARKER_FILE_EXT, logger, remoteConn

Fields inherited from interface com.xebialabs.deployit.plugin.api.flow.Step

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor and Description
ArtifactDeleteStep()
ArtifactDeleteStep(int order, com.xebialabs.deployit.plugin.overthere.HostContainer container, com.xebialabs.deployit.plugin.api.udm.DeployableArtifact artifact, java.lang.String targetDirectory)
ArtifactDeleteStep(int order, com.xebialabs.deployit.plugin.overthere.HostContainer container, java.lang.String targetDirectory)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	deleteAdditionalFiles(java.util.Set<java.lang.String> files)
protected void	deleteArtifact()
protected void	deleteFile(com.xebialabs.overthere.OverthereFile file)
protected void	deleteTargetFile()
protected com.xebialabs.deployit.plugin.api.flow.StepExitCode	doExecute()
protected java.lang.String	generateDescription()
java.util.Set<java.lang.String>	getDeleteAdditionalTargetFiles()
java.lang.String	getDescription()
java.lang.String	getTargetFile()
boolean	isTargetDirectoryShared()
void	setDeleteAdditionalTargetFiles(java.util.Set<java.lang.String> deleteAdditionalTargetFiles)
void	setDescription(java.lang.String description)
void	setTargetDirectoryShared(boolean targetDirectoryShared)
void	setTargetFile(java.lang.String targetFile)
void	setTargetPathSharedSubDirectories(boolean targetPathSharedSubDirectories)

Methods inherited from class com.xebialabs.deployit.plugin.generic.step.BaseDeploymentStep

execute

Methods inherited from class com.xebialabs.deployit.plugin.generic.step.BaseStep

classpathResourceExists, createArtifactUploader, createOrReplaceHostFile, disconnect, evaluateTemplate, evaluateTemplate, evaluateTemplate, evaluateTemplate, getArtifactUploader, getContainer, getCtx, getHostFileSeparator, getHostLineSeparator, getLocalConnection, getRemoteConnection, getRemoteWorkingDirectory, getRemoteWorkingDirPath, handleExecute, hostFileExists, isRetainRemoteWorkingDirOnCompletion, readHostFile, readHostFileLines, readHostXmlFileAsModel, resolveOsSpecificTemplate, setRemoteWorkingDirPath, setRetainRemoteWorkingDirOnCompletion, substringAfterLast, substringAfterLast, uploadToWorkingDirectory, uploadToWorkingDirectory, uploadToWorkingDirectory

Methods inherited from class com.xebialabs.deployit.plugin.steps.CalculatedStep

calculateDescription, calculateOrder, description_$eq, description, doPostConstruct, getOrder, order_$eq, order, setOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

ArtifactDeleteStep

public ArtifactDeleteStep()

ArtifactDeleteStep

public ArtifactDeleteStep(int order,
                  com.xebialabs.deployit.plugin.overthere.HostContainer container,
                  com.xebialabs.deployit.plugin.api.udm.DeployableArtifact artifact,
                  java.lang.String targetDirectory)

ArtifactDeleteStep

public ArtifactDeleteStep(int order,
                  com.xebialabs.deployit.plugin.overthere.HostContainer container,
                  java.lang.String targetDirectory)

Method Detail

doExecute

protected com.xebialabs.deployit.plugin.api.flow.StepExitCode doExecute()
                                                                 throws java.lang.Exception

Specified by:

doExecute in class BaseStep

Throws:

java.lang.Exception

deleteArtifact

protected void deleteArtifact()

deleteTargetFile

protected void deleteTargetFile()

deleteAdditionalFiles

protected void deleteAdditionalFiles(java.util.Set<java.lang.String> files)

deleteFile

protected void deleteFile(com.xebialabs.overthere.OverthereFile file)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface com.xebialabs.deployit.plugin.api.flow.Step

Specified by:

getDescription in interface com.xebialabs.deployit.plugin.steps.BaseStep

Overrides:

getDescription in class com.xebialabs.deployit.plugin.steps.CalculatedStep

generateDescription

protected java.lang.String generateDescription()

getTargetFile

public java.lang.String getTargetFile()

setTargetFile

public void setTargetFile(java.lang.String targetFile)

isTargetDirectoryShared

public boolean isTargetDirectoryShared()

setTargetDirectoryShared

public void setTargetDirectoryShared(boolean targetDirectoryShared)

getDeleteAdditionalTargetFiles

public java.util.Set<java.lang.String> getDeleteAdditionalTargetFiles()

setDeleteAdditionalTargetFiles

public void setDeleteAdditionalTargetFiles(java.util.Set<java.lang.String> deleteAdditionalTargetFiles)

setTargetPathSharedSubDirectories

public void setTargetPathSharedSubDirectories(boolean targetPathSharedSubDirectories)

setDescription

public void setDescription(java.lang.String description)

Specified by:

setDescription in interface com.xebialabs.deployit.plugin.steps.BaseStep

Overrides:

setDescription in class com.xebialabs.deployit.plugin.steps.CalculatedStep